[Backport 13.4] [TASK] Bring the reST markup to the documented house style (#879) - #881
Merged
Merged
Conversation
The guide asks for `.. note::` with two spaces after the dots and a body one level deeper, and for a list marker padded so the item text starts at four. 33 files here still use the older narrow form. 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. Each construct was moved as a whole — marker, body and everything nested below it. Literal content was left alone: a `-` opening a line inside a shell command is not a bullet, and the indentation inside a code example is not this commit's business. The automatic backport of #879 failed, so the same conversion was run against this branch's own files. The rendered output is unchanged. All 71 pages were rendered before and after and compared byte for byte; they differ only in the build timestamp. Releases: main, 14.3, 13.4 Assisted-by: Claude Opus 5 <noreply@anthropic.com> Signed-off-by: Lina Wolf
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 abody one level deeper, and for a list marker padded so the item text
starts at four. 33 files here still use the older narrow form.
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. Each construct was moved as a whole —
marker, body and everything nested below it.
Literal content was left alone: a
-opening a line inside a shellcommand is not a bullet, and the indentation inside a code example is
not this commit's business.
The automatic backport of #879 failed, so the same conversion was run
against this branch's own files.
The rendered output is unchanged. All 71 pages were rendered before and
after and compared byte for byte; they differ only in the build
timestamp.
Releases: main, 14.3, 13.4
Assisted-by: Claude Opus 5 noreply@anthropic.com
Signed-off-by: Lina Wolf