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.

Sign up for GitHub

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
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 26 additions & 18 deletions index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,14 +180,20 @@ Key resources
-------------

* Coding style guides
* :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 •
edited
Loading

Choose a reason for hiding this comment

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

Should these be three-space indents?

https://devguide.python.org/documentation/style-guide/#use-of-whitespace

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.

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

* `Issue tracker`_
* :ref:`experts`

* :ref:`experts`

* `Buildbot status`_
* Source code
* `Browse online <https://github.com/python/cpython/>`_
* `Snapshot of the *main* branch <https://github.com/python/cpython/archive/main.zip>`_

* `Browse online <https://github.com/python/cpython/>`_
* `Snapshot of the *main* branch <https://github.com/python/cpython/archive/main.zip>`_

* PEPs_ (Python Enhancement Proposals)
* :ref:`help`
* :ref:`developers`
Expand All @@ -198,22 +204,24 @@ Key resources
Additional resources
--------------------

* Anyone can clone the sources for this guide. See
:ref:`devguide`.
* Anyone can clone the sources for this guide. See :ref:`devguide`.
* Help with ...
* :ref:`exploring`
* :ref:`grammar`
* :ref:`parser`
* :ref:`compiler`
* :ref:`garbage_collector`

* :ref:`exploring`
* :ref:`grammar`
* :ref:`parser`
* :ref:`compiler`
* :ref:`garbage_collector`

* Tool support
* :ref:`gdb`
* :ref:`clang`
* Various tools with configuration files as found in the `Misc directory`_
* Information about editors and their configurations can be found in the
`wiki <https://wiki.python.org/moin/PythonEditors>`_
* `python.org maintenance`_

* :ref:`gdb`
* :ref:`clang`
* Various tools with configuration files as found in the `Misc directory`_
* Information about editors and their configurations can be found in the
`wiki <https://wiki.python.org/moin/PythonEditors>`_

* `python.org maintenance`_
* :ref:`Search this guide <search>`


Expand Down