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

Standardize RST header syntax #10370

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

tetrapod00
Copy link
Contributor

See #10369. Discuss and approve that PR first. As is, this PR implements the standard order of headers described in that PR:

Page title
==========

Header
------

Sub-header
~~~~~~~~~~

Sub-sub-header
^^^^^^^^^^^^^^

Sub-sub-sub-header
""""""""""""""""""

I think I found all the changes to make here, but I might have missed some pages. Since RST handles header syntax per-page, it's not a big deal to come back later and fix any pages that I mised. In each changed page here, I made sure to read through the whole page and confirm that the required changes have been made.

@tetrapod00 tetrapod00 added enhancement area:getting started Issues and PRs related to the Getting Started section of the documentation area:manual Issues and PRs related to the Manual/Tutorials section of the documentation area:contributing Issues and PRs related to the Contributing/Development section of the documentation area:community Issues and PRs related to the Community section of the documentation content:proofreading Issues and PRs related to proofreading the documentation labels Dec 5, 2024
Comment on lines +77 to +78
~~~~~~~~~~~~~~~~~~~~~~~~~~

Copy link
Contributor Author

@tetrapod00 tetrapod00 Dec 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the one "real" change here, and the source of the +1 line. It adds a space between the header and a table.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:community Issues and PRs related to the Community section of the documentation area:contributing Issues and PRs related to the Contributing/Development section of the documentation area:getting started Issues and PRs related to the Getting Started section of the documentation area:manual Issues and PRs related to the Manual/Tutorials section of the documentation content:proofreading Issues and PRs related to proofreading the documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant