Repository navigation
[TASK] Add a script that fixes the indentation of reST files - #637
Merged
Merged
Conversation
Manuals often indent reST with 3 spaces, put one space after "..", and have headline underlines that are shorter or longer than the headline. Fixing that by hand in a whole manual is slow and easy to get wrong. The writing skill now has a script that indents each reST level by 4 spaces, puts two spaces after "..", pads list markers to 4 columns, and makes headline over- and underlines as long as the headline. Code examples, literal blocks, and comments keep their indentation. With --check, the script only lists the files it would change. It skips files with merge conflict markers, because "=======" looks like a headline underline. The script was used for the form manual of TYPO3 Core. The rendered HTML stayed the same, except where the markup was broken before. Assisted-by: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Lina Wolf
linawolf
force-pushed
the
task/rest-indentation-script
branch
from
October 16, 2026 05:23
07cda39 to
b6eb4d5
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.
Manuals often indent reST with 3 spaces, put one space after "..",
and have headline underlines that are shorter or longer than the
headline. Fixing that by hand in a whole manual is slow and easy to
get wrong.
The writing skill now has a script that indents each reST level by
4 spaces, puts two spaces after "..", pads list markers to 4 columns,
and makes headline over- and underlines as long as the headline. Code
examples, literal blocks, and comments keep their indentation. With
--check, the script only lists the files it would change. It skips
files with merge conflict markers, because "=======" looks like a
headline underline.
The script was used for the form manual of TYPO3 Core. The rendered
HTML stayed the same, except where the markup was broken before.
Assisted-by: Claude Opus 5.5 noreply@anthropic.com
Signed-off-by: Lina Wolf