Skip to content
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

gh-110631: Fix reST indentation in Doc/library #110685

Merged
merged 1 commit into from
Oct 11, 2023

Conversation

ezio-melotti
Copy link
Member

@ezio-melotti ezio-melotti commented Oct 11, 2023

This PR fixes indentation errors that resulted in spurious blockquotes and definition lists in the Doc/library dir.


📚 Documentation preview 📚: https://cpython-previews--110685.org.readthedocs.build/

Comment on lines -1001 to 1002
* width: width
width: width
The width of the column in pixels.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This and the next few chunks created a weird definition list with bullets. I removed the bullets to create a regular definition list. The markup of the dts could be improved by adding some ``...`` too, to make them stand out more.

@erlend-aasland
Copy link
Contributor

Sphinx indents should be three, not two spaces, no?

@ezio-melotti
Copy link
Member Author

Sphinx indents should be three, not two spaces, no?

I just time-machined an answer for you here: #110635 (comment)

@erlend-aasland erlend-aasland changed the title gh-110631: fix wrong indentation in the Doc/library dir. gh-110631: Fix reST indentation in the Doc/library dir Oct 11, 2023
@ezio-melotti ezio-melotti changed the title gh-110631: Fix reST indentation in the Doc/library dir gh-110631: Fix reST indentation in Doc/library Oct 11, 2023
@ezio-melotti ezio-melotti merged commit bb7923f into python:main Oct 11, 2023
25 checks passed
@miss-islington
Copy link
Contributor

Thanks @ezio-melotti for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

Sorry, @ezio-melotti, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker bb7923f556537a463c403dc1097726d8a8e1a6f2 3.11

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 11, 2023
Fix wrong indentation in the Doc/library dir.
(cherry picked from commit bb7923f)

Co-authored-by: Ezio Melotti <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Oct 11, 2023

GH-110736 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Oct 11, 2023
ezio-melotti added a commit to ezio-melotti/cpython that referenced this pull request 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]>
@bedevere-app
Copy link

bedevere-app bot commented Oct 11, 2023

GH-110737 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Oct 11, 2023
ezio-melotti added a commit that referenced this pull request 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 pull request 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 ezio-melotti deleted the fix-ind-library branch October 11, 2023 21:11
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
Fix wrong indentation in the Doc/library dir.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants