Make function helptext more concise with a +bids/Contents.m #32
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
…y doco in a new +bids/Contents.m file This way users can do `help bids` to get info on the overall library, and `help <fcn>` for the individual functions takes up less precious space in the command window.
|
good idea! |
|
Thanks for all the merges! |
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.
What do you think about making the per-function helptext more concise by concentrating the whole-library doco in a central
+bids/Contents.mhelp file (that pops up when you dohelp bids)?This way users can do
help bidsto get info on the overall library, andhelp <fcn>for the individual functions takes up less precious space in the command window. Each of the individual function help texts will have a link to the mainbidshelp item so it'll be easy for users to find.Works in Matlab R2014b-R2019b, though there's a bug in earlier versions of Matlab that causes the help for
help bidsto be displayed twice.