Skip to content

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

Open
@gdementen

Description

@gdementen

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 ...
  • ...

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions