Skip to content

Make Headers Consistent in METplus components User's Guides #371

@lisagoodrich

Description

@lisagoodrich

This is a sub-issue of METplus Issue #898

Describe the Sub-Issue

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 day

Define the Metadata

  • METplotpy - All chapters are correct except Chapter 21 tcmw_cross_section.rst. Make corrections.

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

  • Select Repository and/or Organization level Project(s) or add alert: NEED CYCLE ASSIGNMENT label
  • Select Milestone as the next official version or Future Versions

Metadata

Metadata

Assignees

Type

No type

Projects

Relationships

None yet

Development

No branches or pull requests

Issue actions