Add descriptive parameter names #198
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alessandrofelder
approved these changes
May 7, 2024
There was a problem hiding this comment.
This is a definitive improvement, but the word "use" is still extremely vague, especially if someone does not remember the context from https://brainglobe.info/documentation/brainreg/user-guide/parameters.html ... I wonder whether expanding to "use for registration" or similar may be worth it here?
|
I thought about that, but then it gets very long (and wide). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #194
The parameter names are still not that helpful, but there are tooltips. This looks neater at least!