Refactor BlackRock spec specific functions #1763
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I worked on Blackrock today because of issue #1755 plus another user problem that we encountered on the past NWB workshop and there is an improvement I would like to make.
The current codebase uses generic variant names (
variant_a
,variant_b
,variant_c
) throughout theBlackrockRawIO
implementation, making it difficult for developers to understand which Blackrock file specification version each function handles. When debugging or maintaining code, developers need to:I think is better to get rid of the arbitrary a, b and c and just include the specification directly on the name:
Debugging then becomes easier because the function name directly shows the specification context with the intent clear from the function signature alone.
All of these are private functions so no problem with internal name changing (god bless private functions)
What do you think?