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

Language: replace indices with indexes #1914

Closed
addisoncrump opened this issue Mar 6, 2024 · 5 comments
Closed

Language: replace indices with indexes #1914

addisoncrump opened this issue Mar 6, 2024 · 5 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@addisoncrump
Copy link
Collaborator

addisoncrump commented Mar 6, 2024

We should unify our use of "indices" and "indexes"; presently, we use these effectively interchangeably around the codebase, but this has led to some inconsistent naming of types/information in documentation. Similarly, any types/functions we rename that existed in the previous release should have a second copy with the original name (e.g. a pub type for types, pub fn that calls the intended function for functions) and a #[deprecated] tag explaining the change.

This should preferably be completed after #1886 is merged.

@addisoncrump
Copy link
Collaborator Author

addisoncrump commented Mar 6, 2024

cc @domenukk @andreafioraldi @tokatoka: do we prefer "indices" or "indexes"? They are both valid; "indices" is primarily used in mathematical contexts, "indexes" for other fields.

See conversation below; we want to unify on "indexes".

@tokatoka
Copy link
Member

tokatoka commented Mar 6, 2024

for me indexes

@addisoncrump addisoncrump added documentation Improvements or additions to documentation good first issue Good for newcomers labels Mar 6, 2024
@domenukk
Copy link
Member

domenukk commented Mar 6, 2024

Looks like rust string uses char_indices - but otherwise we have way more uses of indexes in the codebase.

@addisoncrump
Copy link
Collaborator Author

Okay, then indexes should be used.

@addisoncrump addisoncrump changed the title Language: replace indexes with indices or vice versa Language: replace indices with indexes Mar 7, 2024
@domenukk
Copy link
Member

This is done I think

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants