Skip to content

Commit f7cdee9

Browse files
[3.14] gh-110631: Fix some incorrect indents in the documentation (GH-129312) (#134419)
Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
1 parent ac27008 commit f7cdee9

File tree

4 files changed

+69
-69
lines changed

4 files changed

+69
-69
lines changed

Doc/library/functions.rst

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1154,44 +1154,44 @@ are always available. They are listed here in alphabetical order.
11541154

11551155
.. function:: locals()
11561156

1157-
Return a mapping object representing the current local symbol table, with
1158-
variable names as the keys, and their currently bound references as the
1159-
values.
1160-
1161-
At module scope, as well as when using :func:`exec` or :func:`eval` with
1162-
a single namespace, this function returns the same namespace as
1163-
:func:`globals`.
1164-
1165-
At class scope, it returns the namespace that will be passed to the
1166-
metaclass constructor.
1167-
1168-
When using ``exec()`` or ``eval()`` with separate local and global
1169-
arguments, it returns the local namespace passed in to the function call.
1170-
1171-
In all of the above cases, each call to ``locals()`` in a given frame of
1172-
execution will return the *same* mapping object. Changes made through
1173-
the mapping object returned from ``locals()`` will be visible as assigned,
1174-
reassigned, or deleted local variables, and assigning, reassigning, or
1175-
deleting local variables will immediately affect the contents of the
1176-
returned mapping object.
1177-
1178-
In an :term:`optimized scope` (including functions, generators, and
1179-
coroutines), each call to ``locals()`` instead returns a fresh dictionary
1180-
containing the current bindings of the function's local variables and any
1181-
nonlocal cell references. In this case, name binding changes made via the
1182-
returned dict are *not* written back to the corresponding local variables
1183-
or nonlocal cell references, and assigning, reassigning, or deleting local
1184-
variables and nonlocal cell references does *not* affect the contents
1185-
of previously returned dictionaries.
1186-
1187-
Calling ``locals()`` as part of a comprehension in a function, generator, or
1188-
coroutine is equivalent to calling it in the containing scope, except that
1189-
the comprehension's initialised iteration variables will be included. In
1190-
other scopes, it behaves as if the comprehension were running as a nested
1191-
function.
1192-
1193-
Calling ``locals()`` as part of a generator expression is equivalent to
1194-
calling it in a nested generator function.
1157+
Return a mapping object representing the current local symbol table, with
1158+
variable names as the keys, and their currently bound references as the
1159+
values.
1160+
1161+
At module scope, as well as when using :func:`exec` or :func:`eval` with
1162+
a single namespace, this function returns the same namespace as
1163+
:func:`globals`.
1164+
1165+
At class scope, it returns the namespace that will be passed to the
1166+
metaclass constructor.
1167+
1168+
When using ``exec()`` or ``eval()`` with separate local and global
1169+
arguments, it returns the local namespace passed in to the function call.
1170+
1171+
In all of the above cases, each call to ``locals()`` in a given frame of
1172+
execution will return the *same* mapping object. Changes made through
1173+
the mapping object returned from ``locals()`` will be visible as assigned,
1174+
reassigned, or deleted local variables, and assigning, reassigning, or
1175+
deleting local variables will immediately affect the contents of the
1176+
returned mapping object.
1177+
1178+
In an :term:`optimized scope` (including functions, generators, and
1179+
coroutines), each call to ``locals()`` instead returns a fresh dictionary
1180+
containing the current bindings of the function's local variables and any
1181+
nonlocal cell references. In this case, name binding changes made via the
1182+
returned dict are *not* written back to the corresponding local variables
1183+
or nonlocal cell references, and assigning, reassigning, or deleting local
1184+
variables and nonlocal cell references does *not* affect the contents
1185+
of previously returned dictionaries.
1186+
1187+
Calling ``locals()`` as part of a comprehension in a function, generator, or
1188+
coroutine is equivalent to calling it in the containing scope, except that
1189+
the comprehension's initialised iteration variables will be included. In
1190+
other scopes, it behaves as if the comprehension were running as a nested
1191+
function.
1192+
1193+
Calling ``locals()`` as part of a generator expression is equivalent to
1194+
calling it in a nested generator function.
11951195

11961196
.. versionchanged:: 3.12
11971197
The behaviour of ``locals()`` in a comprehension has been updated as

Doc/library/importlib.resources.abc.rst

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -49,44 +49,44 @@
4949
.. method:: open_resource(resource)
5050
:abstractmethod:
5151

52-
Returns an opened, :term:`file-like object` for binary reading
53-
of the *resource*.
52+
Returns an opened, :term:`file-like object` for binary reading
53+
of the *resource*.
5454

55-
If the resource cannot be found, :exc:`FileNotFoundError` is
56-
raised.
55+
If the resource cannot be found, :exc:`FileNotFoundError` is
56+
raised.
5757

5858
.. method:: resource_path(resource)
5959
:abstractmethod:
6060

61-
Returns the file system path to the *resource*.
61+
Returns the file system path to the *resource*.
6262

63-
If the resource does not concretely exist on the file system,
64-
raise :exc:`FileNotFoundError`.
63+
If the resource does not concretely exist on the file system,
64+
raise :exc:`FileNotFoundError`.
6565

6666
.. method:: is_resource(name)
6767
:abstractmethod:
6868

69-
Returns ``True`` if the named *name* is considered a resource.
70-
:exc:`FileNotFoundError` is raised if *name* does not exist.
69+
Returns ``True`` if the named *name* is considered a resource.
70+
:exc:`FileNotFoundError` is raised if *name* does not exist.
7171

7272
.. method:: contents()
7373
:abstractmethod:
7474

75-
Returns an :term:`iterable` of strings over the contents of
76-
the package. Do note that it is not required that all names
77-
returned by the iterator be actual resources, e.g. it is
78-
acceptable to return names for which :meth:`is_resource` would
79-
be false.
80-
81-
Allowing non-resource names to be returned is to allow for
82-
situations where how a package and its resources are stored
83-
are known a priori and the non-resource names would be useful.
84-
For instance, returning subdirectory names is allowed so that
85-
when it is known that the package and resources are stored on
86-
the file system then those subdirectory names can be used
87-
directly.
88-
89-
The abstract method returns an iterable of no items.
75+
Returns an :term:`iterable` of strings over the contents of
76+
the package. Do note that it is not required that all names
77+
returned by the iterator be actual resources, e.g. it is
78+
acceptable to return names for which :meth:`is_resource` would
79+
be false.
80+
81+
Allowing non-resource names to be returned is to allow for
82+
situations where how a package and its resources are stored
83+
are known a priori and the non-resource names would be useful.
84+
For instance, returning subdirectory names is allowed so that
85+
when it is known that the package and resources are stored on
86+
the file system then those subdirectory names can be used
87+
directly.
88+
89+
The abstract method returns an iterable of no items.
9090

9191

9292
.. class:: Traversable

Doc/library/signal.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -211,8 +211,8 @@ The variables defined in the :mod:`signal` module are:
211211

212212
.. data:: SIGSTKFLT
213213

214-
Stack fault on coprocessor. The Linux kernel does not raise this signal: it
215-
can only be raised in user space.
214+
Stack fault on coprocessor. The Linux kernel does not raise this signal: it
215+
can only be raised in user space.
216216

217217
.. availability:: Linux.
218218

Doc/library/socket.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -362,10 +362,10 @@ Exceptions
362362
Constants
363363
^^^^^^^^^
364364

365-
The AF_* and SOCK_* constants are now :class:`AddressFamily` and
366-
:class:`SocketKind` :class:`.IntEnum` collections.
365+
The AF_* and SOCK_* constants are now :class:`AddressFamily` and
366+
:class:`SocketKind` :class:`.IntEnum` collections.
367367

368-
.. versionadded:: 3.4
368+
.. versionadded:: 3.4
369369

370370
.. data:: AF_UNIX
371371
AF_INET
@@ -773,9 +773,9 @@ Constants
773773
Constant to optimize CPU locality, to be used in conjunction with
774774
:data:`SO_REUSEPORT`.
775775

776-
.. versionadded:: 3.11
776+
.. versionadded:: 3.11
777777

778-
.. availability:: Linux >= 3.9
778+
.. availability:: Linux >= 3.9
779779

780780
.. data:: SO_REUSEPORT_LB
781781

0 commit comments

Comments
 (0)