-
Notifications
You must be signed in to change notification settings - Fork 119
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
[develop]: Add plotting and template variable documentation #528
[develop]: Add plotting and template variable documentation #528
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.
@gspetro-NOAA Thank you very much for updating the plotting and template variable documentation! For the most part, everything looks great! I have noted a few minor spelling issues in ConfigWorkflow.rst
.
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.
@gspetro-NOAA I have one more comment, this time in RunSRW.rst
- would it be best to replace $HOME
with $SRW
on line 566? In the BuildSRW
chapter, it suggests that users create an environment variable pointing to their cloned SRW App and call it $SRW
. It might be best to push for the use of this environment variable.
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.
@gspetro-NOAA Thank you very much for addressing my concerns! Approving this work now.
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.
These documentation changes look good to me! Whatever is going on with the workflow for plotting is not related to the docs so approving!
DESCRIPTION OF CHANGES:
Type of change
TESTS CONDUCTED:
None required (all documentation). I built the docs on my RTD account: https://srw-ug.readthedocs.io/en/text-plotting/index.html
Note that ReadTheDocs did dependencies updates on 1/26/22 and 1/4/23 that seem to be causing issues rendering bullet points properly. This will make any bulleted lists in our docs ugly, but the information is still there. I don't think the issue relates to anything I did, since the bullets are not rendering properly anywhere in the docs (including lists I didn't touch). There was also no problem with my RTD builds from 12/22/22.
DEPENDENCIES:
N/A.
DOCUMENTATION:
All documentation.
ISSUE:
Issue #525
Issue #482
Issue #230
CHECKLIST
CONTRIBUTORS (optional):
@danielabdi-noaa @gsketefian @EdwardSnyder-NOAA