Standardize header syntax within About section #10369
Open
+98
−98
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a proof of concept, before making changes to the whole online documentation.
This standardizes our RST header syntax as follows:
Feel free to bikeshed the syntax order here, if you care.
=, -, ~
is fairly common, but so is=, -, ^
."""
is rarely used, but it does follow^^^
when it is used.+++
is occasionally used.Edit: after going through a lot more pages,
=, -, ^
is common on pages with only 3 heading levels, but on pages with four heading levels,=, -, ~, ^
is standard, and=, -, ^, ~
or any variant is almost never used. So I think my original guideline is still correct.Note that RST assigns headers based on the order they appear, within a particular page. So this PR will not change the header level of any existing pages. It only standardizes our syntax. This also means that this PR is not a one-to-one replacement of particular characters with other particular characters. It depends on the existing page!
Approval of this PR indicates the header syntax that I will standardize the rest of the docs with, in #10370.