Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make a glossary of all terms used and simplify and homogenize the vocabulary #1111

Open
gdementen opened this issue Jul 18, 2024 · 1 comment

Comments

@gdementen
Copy link
Contributor

Throughout the API and documentation, we use various terms for very similar or even the same things.

We should:

  • make an exhaustive list of those terms
  • make a glossary of them (even for us, having precise definitions would help to know when to use each term)
  • determine which are most user-friendly (possibly poll our users about this)
  • apply those changes everywhere so that their usage is consistent

Examples include:

  • key vs subset vs selection vs Group vs label vs tick (on a axis) vs filter (as an action for the method name) vs boolean filter (to be used in getitem)
  • axis vs dimension
  • index vs position (including the name "reindex" which I never liked but I don't like relabel either 😉 )
  • axis reference
  • join method vs align vs ...
  • ...
@gdementen
Copy link
Contributor Author

I guess we should split this issue in several: creating a glossary of existing terms could be done relatively quickly, while reviewing the whole API is more an LArray 1.0 thing, which is probably several years away

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant