Describe the Task

The headers for the METplus components User's Guides may not be consistent, but we want them to be.

Here is the syntax from the RST docs (https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections):

# with overline, for parts (e.g. the RTD documentation for the component (i.e. docs/index.rst), each guide (e.g. User's Guide, Contributor's Guide) (i.e. docs/Users_Guide/index.rst, docs/Contributors_Guide/index.rst))
* with overline, for chapters
=, for sections
-, for subsections
^, for subsubsections
", for paragraphs

Time Estimate

1 to 3 days of work

Sub-Issues

Consider breaking the task down into sub-issues.

• Start with the METcalcpy installation documentation: METcalcpy/docs/Users_Guide/installation.rst in the repository
  (Documentation: Make Headers Consistent in METcalcpy User's Guides #313)
• METplotpy - Lisa:They were all correct except Chapter 21 tcmw_cross_section.rst. 7/25/23 pull request submitted Make Headers Consistent in METplus components User's Guides METplotpy#371. Julie found underlines that needed to be dashes. Pull request approved 7/26/23 with changes.
• METplus - Please review "All" guides, including,
  - [x] User's Guide (Please note, the usecases.rst file pulls converted text from python files located under the "use_cases" folder. These do not follow the standard protocol and are separate from all other forms of the documentation. It does not need to be reviewed.)
  - [x] Contributor's Guide (work completed 9/4/23),
  - [x] Verification Datasets Guide - Julie: Lisa, you should still check every file to be detailed and thorough, but upon a quick glance I noticed that all of the Verification Dataset chapters have incorrect headers of underlining ===, but should be underlined and overlined ****. For this work, you can just use this existing issue for METplus for your feature branch.
  - [x] Release Guide, you may need help with this. Lisa: This was very tricky and confusing. I created a sheet, 2023 Release Guide adventures to try and keep track of the 100 files linked across many different chapters.
  - [x] Lisa: I had questions about things outside of the scope of work. I've captured them here for review: 2023 METplus oddities discovered while cleaning up header consistency Per Julie, it is okay to pass on these issues since they are outside of the scope of work.
• MET (Lisa, you need to create a Sub-Issue in the MET repository for this work; Please use the following title Documentation: Make Headers Consistent in All MET Guides) By "All" guides, that means the
  - [x] User's Guide,
  - [x] Contributor's Guide
  The above items were completed on 11/9/23.
• In creating the description for the new issue please use the METcalcpy issue link above as an example. MET issue created 10/16/23: Documentation: Make Headers Consistent in All MET Guides MET#2716
• METdatio (Lisa, you need to create a Sub-Issue in the METdataio repository for this work; Please use the following title Documentation: Make Headers Consistent in All METdataio Guides) By "All" guides, that means the User's, Contributor's, etc. guides. In creating the description for the new issue please use the METcalcpy issue link above as an example. Issue created 10/16/23: Documentation: Make Headers Consistent in All METdataio Guides METdataio#238. Work completed and pull request closed 10/19/23.
• METviewer (Lisa, you need to create a Sub-Issue in the METviewer repository for this work; Please use the following title Documentation: Make Headers Consistent in All METviewer Guides) By "All" guides, that means the User's, Contributor's, etc. guides. In creating the description for the new issue please use the METcalcpy issue link above as an example. Issue createdd 10/16/23: Documentation: Make Headers Consistent in All METviewer Guides METviewer#497

Relevant Deadlines

None

Funding Source

2783543 - Lisa has hours on this account.

Define the Metadata

Assignee

• Select engineer(s) or no engineer required
• Select scientist(s) or no scientist required

Labels

• Select component(s)
• Select priority
• Select requestor(s)

Projects and Milestone

• Review projects and select relevant Repository and Organization ones or add "alert:NEED PROJECT ASSIGNMENT" label
• Select milestone to next major version milestone or "Future Versions"

Define Related Issue(s)

Consider the impact to the other METplus components.

• METplus, MET, METdatadb, METviewer, METexpress, METcalcpy, METplotpy

Task Checklist

See the METplus Workflow for details.

• Complete the issue definition above, including the Time Estimate and Funding Source.
• Fork this repository or create a branch of develop.
  Branch name: feature_<Issue Number>_<Description>
• Complete the development and test your changes.
• Add/update log messages for easier debugging.
• Add/update unit tests.
• Add/update documentation.
• Push local changes to GitHub.
• Submit a pull request to merge into develop.
  Pull request: feature <Issue Number> <Description>
• Define the pull request metadata, as permissions allow.
  Select: Reviewer(s), Project(s), Milestone, and Linked issues
• Iterate until the reviewer(s) accept and merge your changes.
• Delete your fork or branch.
• Close this issue.