Repository navigation
Fix wrongly indented blocks in the documentation #110631
Copy link
Copy link
Closed
Labels
3.11only security fixesonly security fixes3.12only security fixesonly security fixes3.13only security fixesonly security fixesdocsDocumentation in the Doc dirDocumentation in the Doc dirtype-bugAn unexpected behavior, bug, or errorAn unexpected behavior, bug, or error
Description
Activity
- addedtype-bugAn unexpected behavior, bug, or errorAn unexpected behavior, bug, or errordocsDocumentation in the Doc dirDocumentation in the Doc dir3.11only security fixesonly security fixes3.12only security fixesonly security fixes3.13only security fixesonly security fixes
on Oct 10, 2023 - added a commit that references this issue
on Oct 11, 2023 19 remaining items
- added 4 commits that reference this issue
on Sep 2, 2024
Metadata
Metadata
Assignees
Labels
3.11only security fixesonly security fixes3.12only security fixesonly security fixes3.13only security fixesonly security fixesdocsDocumentation in the Doc dirDocumentation in the Doc dirtype-bugAn unexpected behavior, bug, or errorAn unexpected behavior, bug, or error
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) #110741