Skip to content

Commit

Permalink
[3.11] Docs: Fix backtick errors found by sphinx-lint (pythonGH-97998)
Browse files Browse the repository at this point in the history
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>.
(cherry picked from commit fa2d43e)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
  • Loading branch information
hugovk authored and CAM-Gerlach committed Oct 17, 2022
1 parent 211b819 commit a6ea2cc
Show file tree
Hide file tree
Showing 50 changed files with 86 additions and 94 deletions.
2 changes: 1 addition & 1 deletion Doc/c-api/init.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1796,7 +1796,7 @@ is not possible due to its implementation being opaque at build time.
Free the given *key* allocated by :c:func:`PyThread_tss_alloc`, after
first calling :c:func:`PyThread_tss_delete` to ensure any associated
thread locals have been unassigned. This is a no-op if the *key*
argument is `NULL`.
argument is ``NULL``.
.. note::
A freed key becomes a dangling pointer. You should reset the key to
Expand Down
2 changes: 1 addition & 1 deletion Doc/c-api/type.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Type Objects
.. c:function:: unsigned long PyType_GetFlags(PyTypeObject* type)
Return the :c:member:`~PyTypeObject.tp_flags` member of *type*. This function is primarily
meant for use with `Py_LIMITED_API`; the individual flag bits are
meant for use with ``Py_LIMITED_API``; the individual flag bits are
guaranteed to be stable across Python releases, but access to
:c:member:`~PyTypeObject.tp_flags` itself is not part of the limited API.
Expand Down
2 changes: 1 addition & 1 deletion Doc/faq/design.rst
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ Why can't I use an assignment in an expression?

Starting in Python 3.8, you can!

Assignment expressions using the walrus operator `:=` assign a variable in an
Assignment expressions using the walrus operator ``:=`` assign a variable in an
expression::

while chunk := fp.read(200):
Expand Down
2 changes: 1 addition & 1 deletion Doc/howto/enum.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1120,7 +1120,7 @@ Enum Classes
The :class:`EnumType` metaclass is responsible for providing the
:meth:`__contains__`, :meth:`__dir__`, :meth:`__iter__` and other methods that
allow one to do things with an :class:`Enum` class that fail on a typical
class, such as `list(Color)` or `some_enum_var in Color`. :class:`EnumType` is
class, such as ``list(Color)`` or ``some_enum_var in Color``. :class:`EnumType` is
responsible for ensuring that various other methods on the final :class:`Enum`
class are correct (such as :meth:`__new__`, :meth:`__getnewargs__`,
:meth:`__str__` and :meth:`__repr__`).
Expand Down
4 changes: 2 additions & 2 deletions Doc/howto/logging-cookbook.rst
Original file line number Diff line number Diff line change
Expand Up @@ -769,7 +769,7 @@ To run a logging listener in production, you may need to use a process-managemen
such as `Supervisor <http://supervisord.org/>`_. `Here
<https://gist.github.com/vsajip/4b227eeec43817465ca835ca66f75e2b>`_ is a Gist which
provides the bare-bones files to run the above functionality using Supervisor: you
will need to change the `/path/to/` parts in the Gist to reflect the actual paths you
will need to change the ``/path/to/`` parts in the Gist to reflect the actual paths you
want to use.


Expand Down Expand Up @@ -2981,7 +2981,7 @@ Formatting times using UTC (GMT) via configuration
--------------------------------------------------

Sometimes you want to format times using UTC, which can be done using a class
such as `UTCFormatter`, shown below::
such as ``UTCFormatter``, shown below::

import logging
import time
Expand Down
10 changes: 5 additions & 5 deletions Doc/howto/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -552,14 +552,14 @@ raw message. If there is no date format string, the default date format is:
%Y-%m-%d %H:%M:%S
with the milliseconds tacked on at the end. The ``style`` is one of `%`, '{'
or '$'. If one of these is not specified, then '%' will be used.
with the milliseconds tacked on at the end. The ``style`` is one of ``'%'``,
``'{'``, or ``'$'``. If one of these is not specified, then ``'%'`` will be used.

If the ``style`` is '%', the message format string uses
If the ``style`` is ``'%'``, the message format string uses
``%(<dictionary key>)s`` styled string substitution; the possible keys are
documented in :ref:`logrecord-attributes`. If the style is '{', the message
documented in :ref:`logrecord-attributes`. If the style is ``'{'``, the message
format string is assumed to be compatible with :meth:`str.format` (using
keyword arguments), while if the style is '$' then the message format string
keyword arguments), while if the style is ``'$'`` then the message format string
should conform to what is expected by :meth:`string.Template.substitute`.

.. versionchanged:: 3.2
Expand Down
2 changes: 1 addition & 1 deletion Doc/install/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -761,7 +761,7 @@ And on Windows, the configuration files are:
+--------------+-------------------------------------------------+-------+

On all platforms, the "personal" file can be temporarily disabled by
passing the `--no-user-cfg` option.
passing the ``--no-user-cfg`` option.

Notes:

Expand Down
2 changes: 1 addition & 1 deletion Doc/library/asyncio-protocol.rst
Original file line number Diff line number Diff line change
Expand Up @@ -553,7 +553,7 @@ accept factories that return streaming protocols.
a connection is open.

However, :meth:`protocol.eof_received() <Protocol.eof_received>`
is called at most once. Once `eof_received()` is called,
is called at most once. Once ``eof_received()`` is called,
``data_received()`` is not called anymore.

.. method:: Protocol.eof_received()
Expand Down
10 changes: 5 additions & 5 deletions Doc/library/asyncio-task.rst
Original file line number Diff line number Diff line change
Expand Up @@ -631,7 +631,7 @@ Timeouts

Change the time the timeout will trigger.

If *when* is `None`, any current deadline will be removed, and the
If *when* is ``None``, any current deadline will be removed, and the
context manager will wait indefinitely.

If *when* is a float, it is set as the new deadline.
Expand Down Expand Up @@ -867,17 +867,17 @@ Running in Threads
# blocking_io complete at 19:50:54
# finished main at 19:50:54

Directly calling `blocking_io()` in any coroutine would block the event loop
Directly calling ``blocking_io()`` in any coroutine would block the event loop
for its duration, resulting in an additional 1 second of run time. Instead,
by using `asyncio.to_thread()`, we can run it in a separate thread without
by using ``asyncio.to_thread()``, we can run it in a separate thread without
blocking the event loop.

.. note::

Due to the :term:`GIL`, `asyncio.to_thread()` can typically only be used
Due to the :term:`GIL`, ``asyncio.to_thread()`` can typically only be used
to make IO-bound functions non-blocking. However, for extension modules
that release the GIL or alternative Python implementations that don't
have one, `asyncio.to_thread()` can also be used for CPU-bound functions.
have one, ``asyncio.to_thread()`` can also be used for CPU-bound functions.

.. versionadded:: 3.9

Expand Down
2 changes: 1 addition & 1 deletion Doc/library/bdb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ The :mod:`bdb` module also defines two classes:

For real file names, the canonical form is an operating-system-dependent,
:func:`case-normalized <os.path.normcase>` :func:`absolute path
<os.path.abspath>`. A *filename* with angle brackets, such as `"<stdin>"`
<os.path.abspath>`. A *filename* with angle brackets, such as ``"<stdin>"``
generated in interactive mode, is returned unchanged.

.. method:: reset()
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/bz2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ Incremental (de)compression
will be set to ``True``.

Attempting to decompress data after the end of stream is reached
raises an `EOFError`. Any data found after the end of the
raises an :exc:`EOFError`. Any data found after the end of the
stream is ignored and saved in the :attr:`~.unused_data` attribute.

.. versionchanged:: 3.5
Expand Down Expand Up @@ -303,7 +303,7 @@ Using :class:`BZ2Compressor` for incremental compression:
>>> out = out + comp.flush()

The example above uses a very "nonrandom" stream of data
(a stream of `b"z"` chunks). Random data tends to compress poorly,
(a stream of ``b"z"`` chunks). Random data tends to compress poorly,
while ordered, repetitive data usually yields a high compression ratio.

Writing and reading a bzip2-compressed file in binary mode:
Expand Down
6 changes: 3 additions & 3 deletions Doc/library/concurrent.futures.rst
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ And::

All threads enqueued to ``ThreadPoolExecutor`` will be joined before the
interpreter can exit. Note that the exit handler which does this is
executed *before* any exit handlers added using `atexit`. This means
executed *before* any exit handlers added using ``atexit``. This means
exceptions in the main thread must be caught and handled in order to
signal threads to exit gracefully. For this reason, it is recommended
that ``ThreadPoolExecutor`` not be used for long-running tasks.
Expand Down Expand Up @@ -411,13 +411,13 @@ The :class:`Future` class encapsulates the asynchronous execution of a callable.
tests.

If the method returns ``False`` then the :class:`Future` was cancelled,
i.e. :meth:`Future.cancel` was called and returned `True`. Any threads
i.e. :meth:`Future.cancel` was called and returned ``True``. Any threads
waiting on the :class:`Future` completing (i.e. through
:func:`as_completed` or :func:`wait`) will be woken up.

If the method returns ``True`` then the :class:`Future` was not cancelled
and has been put in the running state, i.e. calls to
:meth:`Future.running` will return `True`.
:meth:`Future.running` will return ``True``.

This method can only be called once and cannot be called after
:meth:`Future.set_result` or :meth:`Future.set_exception` have been
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/ctypes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1934,7 +1934,7 @@ Utility functions
.. function:: GetLastError()

Windows only: Returns the last error code set by Windows in the calling thread.
This function calls the Windows `GetLastError()` function directly,
This function calls the Windows ``GetLastError()`` function directly,
it does not return the ctypes-private copy of the error code.

.. function:: get_errno()
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/curses.rst
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ The module :mod:`curses` defines the following functions:
Change the definition of a color, taking the number of the color to be changed
followed by three RGB values (for the amounts of red, green, and blue
components). The value of *color_number* must be between ``0`` and
`COLORS - 1`. Each of *r*, *g*, *b*, must be a value between ``0`` and
``COLORS - 1``. Each of *r*, *g*, *b*, must be a value between ``0`` and
``1000``. When :func:`init_color` is used, all occurrences of that color on the
screen immediately change to the new definition. This function is a no-op on
most terminals; it is active only if :func:`can_change_color` returns ``True``.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/datetime.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1769,7 +1769,7 @@ Other constructor:
ISO 8601 format, with the following exceptions:

1. Time zone offsets may have fractional seconds.
2. The leading `T`, normally required in cases where there may be ambiguity between
2. The leading ``T``, normally required in cases where there may be ambiguity between
a date and a time, is not required.
3. Fractional seconds may have any number of digits (anything beyond 6 will
be truncated).
Expand Down Expand Up @@ -2265,7 +2265,7 @@ where historical changes have been made to civil time.
two digits of ``offset.hours`` and ``offset.minutes`` respectively.

.. versionchanged:: 3.6
Name generated from ``offset=timedelta(0)`` is now plain `'UTC'`, not
Name generated from ``offset=timedelta(0)`` is now plain ``'UTC'``, not
``'UTC+00:00'``.


Expand Down
8 changes: 4 additions & 4 deletions Doc/library/decimal.rst
Original file line number Diff line number Diff line change
Expand Up @@ -576,11 +576,11 @@ Decimal objects
Alternative constructor that only accepts instances of :class:`float` or
:class:`int`.

Note `Decimal.from_float(0.1)` is not the same as `Decimal('0.1')`.
Note ``Decimal.from_float(0.1)`` is not the same as ``Decimal('0.1')``.
Since 0.1 is not exactly representable in binary floating point, the
value is stored as the nearest representable value which is
`0x1.999999999999ap-4`. That equivalent value in decimal is
`0.1000000000000000055511151231257827021181583404541015625`.
``0x1.999999999999ap-4``. That equivalent value in decimal is
``0.1000000000000000055511151231257827021181583404541015625``.

.. note:: From Python 3.2 onwards, a :class:`Decimal` instance
can also be constructed directly from a :class:`float`.
Expand Down Expand Up @@ -1209,7 +1209,7 @@ In addition to the three supplied contexts, new contexts can be created with the

.. method:: exp(x)

Returns `e ** x`.
Returns ``e ** x``.


.. method:: fma(x, y, z)
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/dis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ details of bytecode instructions as :class:`Instruction` instances:

.. class:: Positions

In case the information is not available, some fields might be `None`.
In case the information is not available, some fields might be ``None``.

.. data:: lineno
.. data:: end_lineno
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/email.compat32-message.rst
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ Here are the methods of the :class:`Message` class:
In a model generated from bytes, any header values that (in contravention of
the RFCs) contain non-ASCII bytes will, when retrieved through this
interface, be represented as :class:`~email.header.Header` objects with
a charset of `unknown-8bit`.
a charset of ``unknown-8bit``.


.. method:: __len__()
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/email.headerregistry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ headers.
specified as ``-0000`` (indicating it is in UTC but contains no
information about the source timezone), then :attr:`.datetime` will be a
naive :class:`~datetime.datetime`. If a specific timezone offset is
found (including `+0000`), then :attr:`.datetime` will contain an aware
found (including ``+0000``), then :attr:`.datetime` will contain an aware
``datetime`` that uses :class:`datetime.timezone` to record the timezone
offset.

Expand Down
4 changes: 2 additions & 2 deletions Doc/library/functools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ The :mod:`functools` module defines the following functions:
arguments to the function must be hashable.

Distinct argument patterns may be considered to be distinct calls with
separate cache entries. For example, `f(a=1, b=2)` and `f(b=2, a=1)`
separate cache entries. For example, ``f(a=1, b=2)`` and ``f(b=2, a=1)``
differ in their keyword argument order and may have two separate cache
entries.

Expand Down Expand Up @@ -191,7 +191,7 @@ The :mod:`functools` module defines the following functions:
The cache keeps references to the arguments and return values until they age
out of the cache or until the cache is cleared.

If a method is cached, the `self` instance argument is included in the
If a method is cached, the ``self`` instance argument is included in the
cache. See :ref:`faq-cache-method-calls`

An `LRU (least recently used) cache
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/hashlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ Constructor functions also accept the following tree hashing parameters:
BLAKE2s, 0 in sequential mode).

* *last_node*: boolean indicating whether the processed node is the last
one (`False` for sequential mode).
one (``False`` for sequential mode).

.. figure:: hashlib-blake2-tree.png
:alt: Explanation of tree mode parameters.
Expand Down
6 changes: 3 additions & 3 deletions Doc/library/io.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1055,10 +1055,10 @@ Text I/O
The initial value of the buffer can be set by providing *initial_value*.
If newline translation is enabled, newlines will be encoded as if by
:meth:`~TextIOBase.write`. The stream is positioned at the start of the
buffer which emulates opening an existing file in a `w+` mode, making it
buffer which emulates opening an existing file in a ``w+`` mode, making it
ready for an immediate write from the beginning or for a write that
would overwrite the initial value. To emulate opening a file in an `a+`
mode ready for appending, use `f.seek(0, io.SEEK_END)` to reposition the
would overwrite the initial value. To emulate opening a file in an ``a+``
mode ready for appending, use ``f.seek(0, io.SEEK_END)`` to reposition the
stream at the end of the buffer.

The *newline* argument works like that of :class:`TextIOWrapper`,
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/lzma.rst
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ Compressing and decompressing data in memory
will be set to ``True``.

Attempting to decompress data after the end of stream is reached
raises an `EOFError`. Any data found after the end of the
raises an :exc:`EOFError`. Any data found after the end of the
stream is ignored and saved in the :attr:`~.unused_data` attribute.

.. versionchanged:: 3.5
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/os.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3180,7 +3180,7 @@ features:
system records access and modification times; see :func:`~os.stat`. The best
way to preserve exact times is to use the *st_atime_ns* and *st_mtime_ns*
fields from the :func:`os.stat` result object with the *ns* parameter to
`utime`.
:func:`utime`.

This function can support :ref:`specifying a file descriptor <path_fd>`,
:ref:`paths relative to directory descriptors <dir_fd>` and :ref:`not
Expand Down Expand Up @@ -4072,7 +4072,7 @@ written in Python, such as a mail server's external command delivery program.
library :c:data:`POSIX_SPAWN_RESETIDS` flag.

If the *setsid* argument is ``True``, it will create a new session ID
for `posix_spawn`. *setsid* requires :c:data:`POSIX_SPAWN_SETSID`
for ``posix_spawn``. *setsid* requires :c:data:`POSIX_SPAWN_SETSID`
or :c:data:`POSIX_SPAWN_SETSID_NP` flag. Otherwise, :exc:`NotImplementedError`
is raised.

Expand Down
2 changes: 1 addition & 1 deletion Doc/library/select.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The module defines the following:
events.

*sizehint* informs epoll about the expected number of events to be
registered. It must be positive, or `-1` to use the default. It is only
registered. It must be positive, or ``-1`` to use the default. It is only
used on older systems where :c:func:`epoll_create1` is not available;
otherwise it has no effect (though its value is still checked).

Expand Down
2 changes: 1 addition & 1 deletion Doc/library/socket.rst
Original file line number Diff line number Diff line change
Expand Up @@ -642,7 +642,7 @@ The following functions all create :ref:`socket objects <socket-objects>`.
When :const:`SOCK_NONBLOCK` or :const:`SOCK_CLOEXEC`
bit flags are applied to *type* they are cleared, and
:attr:`socket.type` will not reflect them. They are still passed
to the underlying system `socket()` call. Therefore,
to the underlying system ``socket()`` call. Therefore,

::

Expand Down
2 changes: 1 addition & 1 deletion Doc/library/statistics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -813,7 +813,7 @@ of applications in statistics.
The relative likelihood is computed as the probability of a sample
occurring in a narrow range divided by the width of the range (hence
the word "density"). Since the likelihood is relative to other points,
its value can be greater than `1.0`.
its value can be greater than ``1.0``.

.. method:: NormalDist.cdf(x)

Expand Down
6 changes: 3 additions & 3 deletions Doc/library/sys.rst
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ always available.
Print low-level information to stderr about the state of CPython's memory
allocator.

If Python is `built in debug mode <debug-build>` (:option:`configure
If Python is :ref:`built in debug mode <debug-build>` (:option:`configure
--with-pydebug option <--with-pydebug>`), it also performs some expensive
internal consistency checks.

Expand Down Expand Up @@ -349,7 +349,7 @@ always available.
files to (and read them from) a parallel directory tree rooted at this
directory, rather than from ``__pycache__`` directories in the source code
tree. Any ``__pycache__`` directories in the source code tree will be ignored
and new `.pyc` files written within the pycache prefix. Thus if you use
and new ``.pyc`` files written within the pycache prefix. Thus if you use
:mod:`compileall` as a pre-build step, you must ensure you run it with the
same pycache prefix (if any) that you will use at runtime.

Expand Down Expand Up @@ -874,7 +874,7 @@ always available.
.. function:: get_asyncgen_hooks()

Returns an *asyncgen_hooks* object, which is similar to a
:class:`~collections.namedtuple` of the form `(firstiter, finalizer)`,
:class:`~collections.namedtuple` of the form ``(firstiter, finalizer)``,
where *firstiter* and *finalizer* are expected to be either ``None`` or
functions which take an :term:`asynchronous generator iterator` as an
argument, and are used to schedule finalization of an asynchronous
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/unittest.mock-examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1116,7 +1116,7 @@ on first use).
That aside there is a way to use ``mock`` to affect the results of an import.
Importing fetches an *object* from the :data:`sys.modules` dictionary. Note that it
fetches an *object*, which need not be a module. Importing a module for the
first time results in a module object being put in `sys.modules`, so usually
first time results in a module object being put in ``sys.modules``, so usually
when you import something you get a module back. This need not be the case
however.

Expand Down
Loading

0 comments on commit a6ea2cc

Please sign in to comment.