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 #110724

Merged
merged 2 commits into from
Oct 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 12 additions & 12 deletions Doc/c-api/memory.rst
Original file line number Diff line number Diff line change
Expand Up @@ -491,18 +491,18 @@ Customize Memory Allocators

:c:func:`PyMem_SetAllocator` does have the following contract:

* It can be called after :c:func:`Py_PreInitialize` and before
:c:func:`Py_InitializeFromConfig` to install a custom memory
allocator. There are no restrictions over the installed allocator
other than the ones imposed by the domain (for instance, the Raw
Domain allows the allocator to be called without the GIL held). See
:ref:`the section on allocator domains <allocator-domains>` for more
information.

* If called after Python has finish initializing (after
:c:func:`Py_InitializeFromConfig` has been called) the allocator
**must** wrap the existing allocator. Substituting the current
allocator for some other arbitrary one is **not supported**.
* It can be called after :c:func:`Py_PreInitialize` and before
:c:func:`Py_InitializeFromConfig` to install a custom memory
allocator. There are no restrictions over the installed allocator
other than the ones imposed by the domain (for instance, the Raw
Domain allows the allocator to be called without the GIL held). See
:ref:`the section on allocator domains <allocator-domains>` for more
information.

* If called after Python has finish initializing (after
:c:func:`Py_InitializeFromConfig` has been called) the allocator
**must** wrap the existing allocator. Substituting the current
allocator for some other arbitrary one is **not supported**.

.. versionchanged:: 3.12
All allocators must be thread-safe.
Expand Down
15 changes: 8 additions & 7 deletions Doc/howto/enum.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1156,13 +1156,14 @@ the following are true:
There is a new boundary mechanism that controls how out-of-range / invalid
bits are handled: ``STRICT``, ``CONFORM``, ``EJECT``, and ``KEEP``:

* STRICT --> raises an exception when presented with invalid values
* CONFORM --> discards any invalid bits
* EJECT --> lose Flag status and become a normal int with the given value
* KEEP --> keep the extra bits
- keeps Flag status and extra bits
- extra bits do not show up in iteration
- extra bits do show up in repr() and str()
* STRICT --> raises an exception when presented with invalid values
* CONFORM --> discards any invalid bits
* EJECT --> lose Flag status and become a normal int with the given value
* KEEP --> keep the extra bits

- keeps Flag status and extra bits
- extra bits do not show up in iteration
- extra bits do show up in repr() and str()

The default for Flag is ``STRICT``, the default for ``IntFlag`` is ``EJECT``,
and the default for ``_convert_`` is ``KEEP`` (see ``ssl.Options`` for an
Expand Down
14 changes: 6 additions & 8 deletions Doc/howto/instrumentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ DTrace and SystemTap are monitoring tools, each providing a way to inspect
what the processes on a computer system are doing. They both use
domain-specific languages allowing a user to write scripts which:

- filter which processes are to be observed
- gather data from the processes of interest
- generate reports on the data
- filter which processes are to be observed
- gather data from the processes of interest
- generate reports on the data

As of Python 3.6, CPython can be built with embedded "markers", also
known as "probes", that can be observed by a DTrace or SystemTap script,
Expand Down Expand Up @@ -246,11 +246,9 @@ The output looks like this:

where the columns are:

- time in microseconds since start of script

- name of executable

- PID of process
- time in microseconds since start of script
- name of executable
- PID of process

and the remainder indicates the call/return hierarchy as the script executes.

Expand Down
6 changes: 3 additions & 3 deletions Doc/library/csv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -288,9 +288,9 @@ The :mod:`csv` module defines the following classes:
Inspecting each column, one of two key criteria will be considered to
estimate if the sample contains a header:

- the second through n-th rows contain numeric values
- the second through n-th rows contain strings where at least one value's
length differs from that of the putative header of that column.
- the second through n-th rows contain numeric values
- the second through n-th rows contain strings where at least one value's
length differs from that of the putative header of that column.

Twenty rows after the first row are sampled; if more than half of columns +
rows meet the criteria, :const:`True` is returned.
Expand Down
12 changes: 5 additions & 7 deletions Doc/library/dataclasses.rst
Original file line number Diff line number Diff line change
Expand Up @@ -319,13 +319,11 @@ Module contents
module-level method (see below). Users should never instantiate a
:class:`Field` object directly. Its documented attributes are:

- ``name``: The name of the field.

- ``type``: The type of the field.

- ``default``, ``default_factory``, ``init``, ``repr``, ``hash``,
``compare``, ``metadata``, and ``kw_only`` have the identical
meaning and values as they do in the :func:`field` function.
- ``name``: The name of the field.
- ``type``: The type of the field.
- ``default``, ``default_factory``, ``init``, ``repr``, ``hash``,
``compare``, ``metadata``, and ``kw_only`` have the identical
meaning and values as they do in the :func:`field` function.

Other attributes may exist, but they are private and must not be
inspected or relied on.
Expand Down
8 changes: 4 additions & 4 deletions Doc/library/decimal.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1396,10 +1396,10 @@ In addition to the three supplied contexts, new contexts can be created with the
With three arguments, compute ``(x**y) % modulo``. For the three argument
form, the following restrictions on the arguments hold:

- all three arguments must be integral
- ``y`` must be nonnegative
- at least one of ``x`` or ``y`` must be nonzero
- ``modulo`` must be nonzero and have at most 'precision' digits
- all three arguments must be integral
- ``y`` must be nonnegative
- at least one of ``x`` or ``y`` must be nonzero
- ``modulo`` must be nonzero and have at most 'precision' digits

The value resulting from ``Context.power(x, y, modulo)`` is
equal to the value that would be obtained by computing ``(x**y)
Expand Down
12 changes: 6 additions & 6 deletions Doc/library/os.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3795,9 +3795,9 @@ Naturally, they are all only available on Linux.

The file descriptor returned by :func:`timerfd_create` supports:

- :func:`read`
- :func:`~select.select`
- :func:`~select.poll`.
- :func:`read`
- :func:`~select.select`
- :func:`~select.poll`

The file descriptor's :func:`read` method can be called with a buffer size
of 8. If the timer has already expired one or more times, :func:`read`
Expand Down Expand Up @@ -3896,9 +3896,9 @@ Naturally, they are all only available on Linux.

Discontinuous system clock change will be caused by the following events:

- ``settimeofday``
- ``clock_settime``
- set the system date and time by ``date`` command
- ``settimeofday``
- ``clock_settime``
- set the system date and time by ``date`` command

Return a two-item tuple of (``next_expiration``, ``interval``) from
the previous timer state, before this function executed.
Expand Down
25 changes: 13 additions & 12 deletions Doc/using/windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1195,21 +1195,22 @@ Otherwise, your users may experience problems using your application. Note that
the first suggestion is the best, as the others may still be susceptible to
non-standard paths in the registry and user site-packages.

.. versionchanged::
3.6
.. versionchanged:: 3.6

Add ``._pth`` file support and removes ``applocal`` option from
``pyvenv.cfg``.

.. versionchanged:: 3.6

* Adds ``._pth`` file support and removes ``applocal`` option from
``pyvenv.cfg``.
* Adds :file:`python{XX}.zip` as a potential landmark when directly adjacent
to the executable.
Add :file:`python{XX}.zip` as a potential landmark when directly adjacent
to the executable.

.. deprecated::
3.6
.. deprecated:: 3.6
Comment on lines -1198 to +1208
Copy link
Member Author

Choose a reason for hiding this comment

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

The way this rendered was a bit inconsistent, since the versionchanged had an indented list and the deprecation had inline text. By adding two separate versionchanged, we get rid of the list and the result looks more consistent (3 separate notes with inline text).


Modules specified in the registry under ``Modules`` (not ``PythonPath``)
may be imported by :class:`importlib.machinery.WindowsRegistryFinder`.
This finder is enabled on Windows in 3.6.0 and earlier, but may need to
be explicitly added to :data:`sys.meta_path` in the future.
Modules specified in the registry under ``Modules`` (not ``PythonPath``)
may be imported by :class:`importlib.machinery.WindowsRegistryFinder`.
This finder is enabled on Windows in 3.6.0 and earlier, but may need to
be explicitly added to :data:`sys.meta_path` in the future.

Additional modules
==================
Expand Down
Loading