Skip to content
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

Open
rtopfer opened this issue Jun 2, 2020 · 4 comments
Open
Labels
enhancement New feature or request

Comments

@rtopfer
Copy link
Contributor

rtopfer commented Jun 2, 2020

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.

@jcohenadad
Copy link
Member

jcohenadad commented Jun 21, 2020

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 __FIELD__ by FIELD? I assume it would be as easily parsed, and looks better when calling the help in the command window. @rtopfer? @po09i?

@rtopfer
Copy link
Contributor Author

rtopfer commented Jun 22, 2020

can we replace FIELD by FIELD?

yes, easily done using replace

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.

@jcohenadad
Copy link
Member

Related to: shimming-toolbox/shimming-toolbox#133

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants