Skip to content

Commit cae968b

Browse files
[3.12] gh-110631: Fix reST indentation in Doc/library (GH-110685) (#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]>
1 parent e6c53dd commit cae968b

34 files changed

+933
-926
lines changed

Doc/library/__main__.rst

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -54,45 +54,45 @@ The top-level code environment can be:
5454

5555
* the scope of an interactive prompt::
5656

57-
>>> __name__
58-
'__main__'
57+
>>> __name__
58+
'__main__'
5959

6060
* the Python module passed to the Python interpreter as a file argument:
6161

62-
.. code-block:: shell-session
62+
.. code-block:: shell-session
6363
64-
$ python helloworld.py
65-
Hello, world!
64+
$ python helloworld.py
65+
Hello, world!
6666
6767
* the Python module or package passed to the Python interpreter with the
6868
:option:`-m` argument:
6969

70-
.. code-block:: shell-session
70+
.. code-block:: shell-session
7171
72-
$ python -m tarfile
73-
usage: tarfile.py [-h] [-v] (...)
72+
$ python -m tarfile
73+
usage: tarfile.py [-h] [-v] (...)
7474
7575
* Python code read by the Python interpreter from standard input:
7676

77-
.. code-block:: shell-session
77+
.. code-block:: shell-session
7878
79-
$ echo "import this" | python
80-
The Zen of Python, by Tim Peters
79+
$ echo "import this" | python
80+
The Zen of Python, by Tim Peters
8181
82-
Beautiful is better than ugly.
83-
Explicit is better than implicit.
84-
...
82+
Beautiful is better than ugly.
83+
Explicit is better than implicit.
84+
...
8585
8686
* Python code passed to the Python interpreter with the :option:`-c` argument:
8787

88-
.. code-block:: shell-session
88+
.. code-block:: shell-session
8989
90-
$ python -c "import this"
91-
The Zen of Python, by Tim Peters
90+
$ python -c "import this"
91+
The Zen of Python, by Tim Peters
9292
93-
Beautiful is better than ugly.
94-
Explicit is better than implicit.
95-
...
93+
Beautiful is better than ugly.
94+
Explicit is better than implicit.
95+
...
9696
9797
In each of these situations, the top-level module's ``__name__`` is set to
9898
``'__main__'``.
@@ -102,9 +102,9 @@ top-level environment by checking its own ``__name__``, which allows a common
102102
idiom for conditionally executing code when the module is not initialized from
103103
an import statement::
104104

105-
if __name__ == '__main__':
106-
# Execute when the module is not initialized from an import statement.
107-
...
105+
if __name__ == '__main__':
106+
# Execute when the module is not initialized from an import statement.
107+
...
108108

109109
.. seealso::
110110

Doc/library/_thread.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ In addition to these methods, lock objects can also be used via the
208208

209209
**Caveats:**
210210

211-
.. index:: pair: module; signal
211+
.. index:: pair: module; signal
212212

213213
* Threads interact strangely with interrupts: the :exc:`KeyboardInterrupt`
214214
exception will be received by an arbitrary thread. (When the :mod:`signal`

Doc/library/binascii.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,11 @@ The :mod:`binascii` module defines the following functions:
5858
data will raise :exc:`binascii.Error`.
5959

6060
Valid base64:
61-
* Conforms to :rfc:`3548`.
62-
* Contains only characters from the base64 alphabet.
63-
* Contains no excess data after padding (including excess padding, newlines, etc.).
64-
* Does not start with a padding.
61+
62+
* Conforms to :rfc:`3548`.
63+
* Contains only characters from the base64 alphabet.
64+
* Contains no excess data after padding (including excess padding, newlines, etc.).
65+
* Does not start with a padding.
6566

6667
.. versionchanged:: 3.11
6768
Added the *strict_mode* parameter.

Doc/library/collections.rst

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -120,26 +120,26 @@ The class can be used to simulate nested scopes and is useful in templating.
120120

121121
.. seealso::
122122

123-
* The `MultiContext class
124-
<https://github.com/enthought/codetools/blob/4.0.0/codetools/contexts/multi_context.py>`_
125-
in the Enthought `CodeTools package
126-
<https://github.com/enthought/codetools>`_ has options to support
127-
writing to any mapping in the chain.
123+
* The `MultiContext class
124+
<https://github.com/enthought/codetools/blob/4.0.0/codetools/contexts/multi_context.py>`_
125+
in the Enthought `CodeTools package
126+
<https://github.com/enthought/codetools>`_ has options to support
127+
writing to any mapping in the chain.
128128

129-
* Django's `Context class
130-
<https://github.com/django/django/blob/main/django/template/context.py>`_
131-
for templating is a read-only chain of mappings. It also features
132-
pushing and popping of contexts similar to the
133-
:meth:`~collections.ChainMap.new_child` method and the
134-
:attr:`~collections.ChainMap.parents` property.
129+
* Django's `Context class
130+
<https://github.com/django/django/blob/main/django/template/context.py>`_
131+
for templating is a read-only chain of mappings. It also features
132+
pushing and popping of contexts similar to the
133+
:meth:`~collections.ChainMap.new_child` method and the
134+
:attr:`~collections.ChainMap.parents` property.
135135

136-
* The `Nested Contexts recipe
137-
<https://code.activestate.com/recipes/577434/>`_ has options to control
138-
whether writes and other mutations apply only to the first mapping or to
139-
any mapping in the chain.
136+
* The `Nested Contexts recipe
137+
<https://code.activestate.com/recipes/577434/>`_ has options to control
138+
whether writes and other mutations apply only to the first mapping or to
139+
any mapping in the chain.
140140

141-
* A `greatly simplified read-only version of Chainmap
142-
<https://code.activestate.com/recipes/305268/>`_.
141+
* A `greatly simplified read-only version of Chainmap
142+
<https://code.activestate.com/recipes/305268/>`_.
143143

144144

145145
:class:`ChainMap` Examples and Recipes
@@ -429,22 +429,22 @@ or subtracting from an empty counter.
429429

430430
.. seealso::
431431

432-
* `Bag class <https://www.gnu.org/software/smalltalk/manual-base/html_node/Bag.html>`_
433-
in Smalltalk.
432+
* `Bag class <https://www.gnu.org/software/smalltalk/manual-base/html_node/Bag.html>`_
433+
in Smalltalk.
434434

435-
* Wikipedia entry for `Multisets <https://en.wikipedia.org/wiki/Multiset>`_.
435+
* Wikipedia entry for `Multisets <https://en.wikipedia.org/wiki/Multiset>`_.
436436

437-
* `C++ multisets <http://www.java2s.com/Tutorial/Cpp/0380__set-multiset/Catalog0380__set-multiset.htm>`_
438-
tutorial with examples.
437+
* `C++ multisets <http://www.java2s.com/Tutorial/Cpp/0380__set-multiset/Catalog0380__set-multiset.htm>`_
438+
tutorial with examples.
439439

440-
* For mathematical operations on multisets and their use cases, see
441-
*Knuth, Donald. The Art of Computer Programming Volume II,
442-
Section 4.6.3, Exercise 19*.
440+
* For mathematical operations on multisets and their use cases, see
441+
*Knuth, Donald. The Art of Computer Programming Volume II,
442+
Section 4.6.3, Exercise 19*.
443443

444-
* To enumerate all distinct multisets of a given size over a given set of
445-
elements, see :func:`itertools.combinations_with_replacement`::
444+
* To enumerate all distinct multisets of a given size over a given set of
445+
elements, see :func:`itertools.combinations_with_replacement`::
446446

447-
map(Counter, combinations_with_replacement('ABC', 2)) # --> AA AB AC BB BC CC
447+
map(Counter, combinations_with_replacement('ABC', 2)) # --> AA AB AC BB BC CC
448448

449449

450450
:class:`deque` objects
@@ -1060,20 +1060,20 @@ fields:
10601060

10611061
.. seealso::
10621062

1063-
* See :class:`typing.NamedTuple` for a way to add type hints for named
1064-
tuples. It also provides an elegant notation using the :keyword:`class`
1065-
keyword::
1063+
* See :class:`typing.NamedTuple` for a way to add type hints for named
1064+
tuples. It also provides an elegant notation using the :keyword:`class`
1065+
keyword::
10661066

1067-
class Component(NamedTuple):
1068-
part_number: int
1069-
weight: float
1070-
description: Optional[str] = None
1067+
class Component(NamedTuple):
1068+
part_number: int
1069+
weight: float
1070+
description: Optional[str] = None
10711071

1072-
* See :meth:`types.SimpleNamespace` for a mutable namespace based on an
1073-
underlying dictionary instead of a tuple.
1072+
* See :meth:`types.SimpleNamespace` for a mutable namespace based on an
1073+
underlying dictionary instead of a tuple.
10741074

1075-
* The :mod:`dataclasses` module provides a decorator and functions for
1076-
automatically adding generated special methods to user-defined classes.
1075+
* The :mod:`dataclasses` module provides a decorator and functions for
1076+
automatically adding generated special methods to user-defined classes.
10771077

10781078

10791079
:class:`OrderedDict` objects

0 commit comments

Comments
 (0)