-
-
Notifications
You must be signed in to change notification settings - Fork 30.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix wrongly indented blocks in the documentation #110631
Comments
ezio-melotti
added
type-bug
An unexpected behavior, bug, or error
docs
Documentation in the Doc dir
3.11
only security fixes
3.12
bugs and security fixes
3.13
bugs and security fixes
labels
Oct 10, 2023
6 tasks
AlexWaygood
pushed a commit
that referenced
this issue
Oct 10, 2023
Set three-space indents in EditorConfig
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Oct 10, 2023
…thonGH-110635) Set three-space indents in EditorConfig (cherry picked from commit 66a9b10) Co-authored-by: Hugo van Kemenade <[email protected]>
This was referenced Oct 10, 2023
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Oct 10, 2023
…thonGH-110635) Set three-space indents in EditorConfig (cherry picked from commit 66a9b10) Co-authored-by: Hugo van Kemenade <[email protected]>
hugovk
pushed a commit
that referenced
this issue
Oct 11, 2023
Fix wrong indentation in the Doc/whatsnew dir.
ezio-melotti
added a commit
to ezio-melotti/cpython
that referenced
this issue
Oct 11, 2023
…hon#110632) Fix wrong indentation in the Doc/whatsnew dir. (cherry picked from commit 3dd593e)
ezio-melotti
added a commit
to ezio-melotti/cpython
that referenced
this issue
Oct 11, 2023
…hon#110632) Fix wrong indentation in the Doc/whatsnew dir. (cherry picked from commit 3dd593e)
This was referenced Oct 11, 2023
ezio-melotti
added a commit
that referenced
this issue
Oct 11, 2023
Fix wrong indentation in the Doc/library dir.
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Oct 11, 2023
Fix wrong indentation in the Doc/library dir. (cherry picked from commit bb7923f) Co-authored-by: Ezio Melotti <[email protected]>
ezio-melotti
added a commit
to ezio-melotti/cpython
that referenced
this issue
Oct 11, 2023
…GH-110685) Fix wrong indentation in the Doc/library dir.. (cherry picked from commit bb7923f) Co-authored-by: Ezio Melotti <[email protected]>
ezio-melotti
added a commit
that referenced
this issue
Oct 11, 2023
* Fix wrong indentation in the other dirs. * Fix more wrong indentation.
ezio-melotti
added a commit
to ezio-melotti/cpython
that referenced
this issue
Oct 11, 2023
* Fix wrong indentation in the other dirs. * Fix more wrong indentation.. (cherry picked from commit 718391f) Co-authored-by: Ezio Melotti <[email protected]>
ezio-melotti
added a commit
to ezio-melotti/cpython
that referenced
this issue
Oct 11, 2023
* Fix wrong indentation in the other dirs. * Fix more wrong indentation.. (cherry picked from commit 718391f) Co-authored-by: Ezio Melotti <[email protected]>
ezio-melotti
added a commit
that referenced
this issue
Oct 11, 2023
Fix wrong indentation in the Doc/reference dir.
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Oct 11, 2023
…0708) Fix wrong indentation in the Doc/reference dir. (cherry picked from commit 41d8ec5) Co-authored-by: Ezio Melotti <[email protected]>
ezio-melotti
added a commit
to ezio-melotti/cpython
that referenced
this issue
Oct 11, 2023
…onGH-110708) Fix wrong indentation in the Doc/reference dir.. (cherry picked from commit 41d8ec5) Co-authored-by: Ezio Melotti <[email protected]>
ezio-melotti
added a commit
that referenced
this issue
Oct 11, 2023
…110736) gh-110631: Fix reST indentation in `Doc/library` (GH-110685) Fix wrong indentation in the Doc/library dir. (cherry picked from commit bb7923f) Co-authored-by: Ezio Melotti <[email protected]>
ezio-melotti
added a commit
that referenced
this issue
Oct 11, 2023
…110737) * [3.11] gh-110631: Fix reST indentation in `Doc/library` (GH-110685) Fix wrong indentation in the Doc/library dir.. (cherry picked from commit bb7923f) Co-authored-by: Ezio Melotti <[email protected]> * Fix merge glitch.
ezio-melotti
added a commit
that referenced
this issue
Oct 11, 2023
ezio-melotti
added a commit
that referenced
this issue
Oct 11, 2023
ezio-melotti
added a commit
that referenced
this issue
Oct 11, 2023
…#110740) gh-110631: Fix reST indentation in `Doc/reference` (GH-110708) Fix wrong indentation in the Doc/reference dir. (cherry picked from commit 41d8ec5) Co-authored-by: Ezio Melotti <[email protected]>
ezio-melotti
added a commit
that referenced
this issue
Oct 12, 2023
All the issues should now be fixed, merged, and backported. The next step is adding the checker I wrote to detect these issues to Thanks to @pradyunsg, @hugovk, and @AlexWaygood for helping me with this issue/PRs! |
Glyphack
pushed a commit
to Glyphack/cpython
that referenced
this issue
Sep 2, 2024
…thon#110635) Set three-space indents in EditorConfig
Glyphack
pushed a commit
to Glyphack/cpython
that referenced
this issue
Sep 2, 2024
…hon#110632) Fix wrong indentation in the Doc/whatsnew dir.
Glyphack
pushed a commit
to Glyphack/cpython
that referenced
this issue
Sep 2, 2024
Fix wrong indentation in the Doc/library dir.
Glyphack
pushed a commit
to Glyphack/cpython
that referenced
this issue
Sep 2, 2024
* Fix wrong indentation in the other dirs. * Fix more wrong indentation.
Glyphack
pushed a commit
to Glyphack/cpython
that referenced
this issue
Sep 2, 2024
Fix wrong indentation in the Doc/reference dir.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Bug report
In the documentation there are several blocks that are indented incorrectly but don't produce errors when the documentation is built. Two common mistakes wrap the misindented block into an additional blockquote or definition list, causing extra indentation in the rendered output but no other visible problems (at least with the current theme).
This is a follow-up of python/devguide#1178 and the linked PRs that fixed a list of similar issues in the devguide repository.
I'm working on a few PRs that fix these errors in the docs.
Linked PRs
Doc/whatsnew
#110632Doc/whatsnew
(GH-110632) #110690Doc/whatsnew
(GH-110632) #110691Doc/library
#110685Doc/library
(GH-110685) #110736Doc/library
(GH-110685) #110737Doc/reference
#110708Doc/reference
(GH-110708) #110740Doc/reference
(GH-110708) #110741The text was updated successfully, but these errors were encountered: