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

[FEATURE] Improve the naming of internal index sequence #839

Open
Jerry-Jinfeng-Guo opened this issue Nov 21, 2024 · 2 comments
Open

[FEATURE] Improve the naming of internal index sequence #839

Jerry-Jinfeng-Guo opened this issue Nov 21, 2024 · 2 comments
Labels
feature New feature or request improvement Improvement on internal implementation

Comments

@Jerry-Jinfeng-Guo
Copy link
Contributor

At the moment the use of sequence_idx and sequence_idx_map is spread across places in the main core. The naming choice of sequence_idx and sequence_idx_map does not truly reflect the nature of the data type:

  • sequence_idx_map is not a map, but rather a sequence of Idx2D.
  • sequence_idx has a very vague definition and can be confused with functionalities with naming like *sequence_offset, which do exist.

The names should be updated to reflect the nature better and to have as little confusions like *_offset vs *_idx. Also, the use of idx itself should be taken with great care, as it not only indicates index in general, but could at times refer to the data type Idx.

@Jerry-Jinfeng-Guo Jerry-Jinfeng-Guo added feature New feature or request improvement Improvement on internal implementation labels Nov 21, 2024
@figueroa1395
Copy link
Contributor

Minor: Now I don't see it in the chat notes, but didn't we agree to remove the [FEATURE] thing before the title for the issues as well? Or am I wrong.

Besides that, thanks for adding this here.

@Jerry-Jinfeng-Guo
Copy link
Contributor Author

Minor: Now I don't see it in the chat notes, but didn't we agree to remove the [FEATURE] thing before the title for the issues as well? Or am I wrong.

Besides that, thanks for adding this here.

We agreed on the pull requests, not feature requests. By default Github gives you [CATEGORY] *your title* , which is fairly consistent throughout the board. In short, we don't do anything specially different for Issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request improvement Improvement on internal implementation
Projects
Status: No status
Development

No branches or pull requests

2 participants