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

Fix wrongly indented nested list in index.rst. #1184

Merged
merged 1 commit into from
Oct 10, 2023

Conversation

ezio-melotti
Copy link
Member

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

Follow-up of #1183 -- fixes a similar error in index.rst.


📚 Documentation preview 📚: https://cpython-devguide--1184.org.readthedocs.build/

* :PEP:`7` (Style Guide for C Code)
* :PEP:`8` (Style Guide for Python Code)

* :PEP:`7` (Style Guide for C Code)
Copy link
Member

@hugovk hugovk Oct 10, 2023

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

Lists work a bit differently (and that's the reason why people often get them wrong). See
https://devguide.python.org/documentation/markup/#lists-and-quotes

We could clarify these exceptions in the devguide (possibly in both places).

Copy link
Member

Choose a reason for hiding this comment

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

For posterity: Using three-space indents in this specific spot would result in a blockquote (or dl, depending on the absence of a blank line) in this specific spot.

@ezio-melotti ezio-melotti merged commit 862e98d into python:main Oct 10, 2023
@ezio-melotti ezio-melotti deleted the index-list-bugs branch October 10, 2023 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants