PowerGridModel
[FEATURE] Improve the naming of internal index sequence
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_mapis not amap, but rather a sequence of Idx2D. -
sequence_idxhas 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.
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.
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