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 User's Guide documentation on how to use the plotting scripts in the workflow #525

Closed
gspetro-NOAA opened this issue Dec 22, 2022 · 0 comments · Fixed by #528
Closed
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@gspetro-NOAA
Copy link
Collaborator

Description

Currently, the ReadTheDocs (RTD) documentation does not reflect the addition of the plot_allvars task to the workflow in PR #482.

Solution

Update the following files to reflect the changes made in PR #482 :

  • RunSRW.rst --> Update the plotting section to reflect that plotting scripts are now part of the workflow. Migrate relevant information from the Graphics chapter to the RunSRW chapter.
  • Delete the Graphics.rst file once relevant info is incorporated into RunSRW.rst.
  • ConfigWorkflow.rst --> Add variables and descriptions from the config_defaults.yaml documentation to this file.
@gspetro-NOAA gspetro-NOAA self-assigned this Dec 22, 2022
@gspetro-NOAA gspetro-NOAA added the documentation Improvements or additions to documentation label Dec 22, 2022
@MichaelLueken MichaelLueken linked a pull request Jan 5, 2023 that will close this issue
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant