-
Notifications
You must be signed in to change notification settings - Fork 134
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 Tutorial to User Guide as Appendix #485
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great!
Should the appendices be after or before the references? |
I don't really have a preference. |
These appendices make most sense before the references, in my opinion. This is awesome, thank you very much. I do (as usual) have quite a few little tweaky grammar kinds of things. I'll clone the branch... |
We could also get rid of the formal rst subsections (6.2.1, 6.2.2, etc) and just make those bolded (or similar) headings in the tutorial. That would remove them from the table of contents. I'm not sure they each deserve a separate rst section/heading. |
I like how visible the subsections are in the text, and I don't mind them showing up in the table of contents. |
editing and committing in github is fine. individual commits are created just like if you did it in a sandbox. |
Everything looks good to me. Any other comments/changes? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great, thank you!
PR checklist
Add Tutorial to User Guide as Appendix
apcraig
No testing done, only documentation changes, reviewed documentation via readthedocs
Add the tutorial to the user guide as an appendix. Allows for easy links into the rest of the documentation and gives it a permanent and accessible home. The icepack variable name table was also moved to the new appendix section.