[TASK] Bring the reST markup to the documented house style - #570
Merged
Merged
Conversation
The guide asks for `.. note::` with two spaces after the dots and a body one level deeper, and for one indentation level to be four spaces. Two files here fall short: the two hyperlink targets in Licenses.rst are written with one space, and the two block quotes in Format.rst are indented three. This is not a search and replace. Three spaces is correct under a marker written with one space, and a continuation line has to keep lining up with where its item text begins, so each construct was moved as a whole. The markup shown inside code blocks was left alone. This manual demonstrates reST for a living, and 41 of its example lines deliberately or accidentally show the narrow form; changing what the guide holds up as an example is an editorial decision, not an indentation fix. The rendered output is unchanged. All 95 pages were rendered before and after and compared byte for byte; they differ only in the build timestamp. Assisted-by: Claude Opus 5 <noreply@anthropic.com> Signed-off-by: Lina Wolf
linawolf
force-pushed
the
task/fix-rest-indentation
branch
from
September 14, 2026 09:25
f1726d4 to
544411a
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The guide asks for
.. note::with two spaces after the dots and a bodyone level deeper, and for one indentation level to be four spaces. Two
files here fall short: the two hyperlink targets in Licenses.rst are
written with one space, and the two block quotes in Format.rst are
indented three.
This is not a search and replace. Three spaces is correct under a marker
written with one space, and a continuation line has to keep lining up
with where its item text begins, so each construct was moved as a whole.
The markup shown inside code blocks was left alone. This manual
demonstrates reST for a living, and 41 of its example lines deliberately
or accidentally show the narrow form; changing what the guide holds up as
an example is an editorial decision, not an indentation fix.
The rendered output is unchanged. All 95 pages were rendered before and
after and compared byte for byte; they differ only in the build
timestamp.
Assisted-by: Claude Opus 5 noreply@anthropic.com
Signed-off-by: Lina Wolf