-
Notifications
You must be signed in to change notification settings - Fork 0
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
Add/finish templates for m-file user documentation to Advisor class #5
Comments
Started something here. I know it's somewhat a duplicate of function_template.m, but it has the merit of being a "real-life" example. My first question would be: can we replace |
yes, easily done using on another note, I'm still in favour of not including authorship in the doc header (except, of course, when the file has been taken from somewhere else). it doesn't strike me as particularly useful and encourages contact via email rather than through GitHub issues. |
Related to: shimming-toolbox/shimming-toolbox#133 |
To standardize and facilitate documenting new .m files, templates should be made available.
I.e. Standard formating for help section of scripts, functions, classes + class members.
e.g. Should there be standard sections such as
Summary
Inputs
References
Etc.
The text was updated successfully, but these errors were encountered: