Fix some incorrect indents in the document #13437
Merged
Conversation
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
Incorrect indents cause some texts to be misinterpreted and render incorrectly.
|
Thanks for the PR. Can you explain what's the issue with the existing indents? |
uranusjr
added
the
skip news
ichard26
approved these changes
Jun 23, 2025
There was a problem hiding this comment.
If you look at the ReadTheDocs preview, you'll notice that admonitions were missing or the indention was broken.
I tried to look for pre-commit linters that could catch these issues for us, neither https://github.com/rstcheck/rstcheck nor https://github.com/PyCQA/doc8 flagged these indention issues :(
|
Thank you for catching these! You got a keen eye :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Incorrect indents cause some texts to be misinterpreted and render incorrectly.