Skip to content
Snippets Groups Projects
Unverified Commit fa2d43e5 authored by Hugo van Kemenade's avatar Hugo van Kemenade Committed by GitHub
Browse files

Docs: Fix backtick errors found by sphinx-lint (#97998)

parent 27025e15
No related branches found
No related tags found
No related merge requests found
Showing
with 36 additions and 36 deletions
...@@ -1929,7 +1929,7 @@ is not possible due to its implementation being opaque at build time. ...@@ -1929,7 +1929,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 Free the given *key* allocated by :c:func:`PyThread_tss_alloc`, after
first calling :c:func:`PyThread_tss_delete` to ensure any associated first calling :c:func:`PyThread_tss_delete` to ensure any associated
thread locals have been unassigned. This is a no-op if the *key* thread locals have been unassigned. This is a no-op if the *key*
argument is `NULL`. argument is ``NULL``.
.. note:: .. note::
A freed key becomes a dangling pointer. You should reset the key to A freed key becomes a dangling pointer. You should reset the key to
......
...@@ -40,7 +40,7 @@ Type Objects ...@@ -40,7 +40,7 @@ Type Objects
.. c:function:: unsigned long PyType_GetFlags(PyTypeObject* type) .. c:function:: unsigned long PyType_GetFlags(PyTypeObject* type)
Return the :c:member:`~PyTypeObject.tp_flags` member of *type*. This function is primarily 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 guaranteed to be stable across Python releases, but access to
:c:member:`~PyTypeObject.tp_flags` itself is not part of the limited API. :c:member:`~PyTypeObject.tp_flags` itself is not part of the limited API.
......
...@@ -155,7 +155,7 @@ Why can't I use an assignment in an expression? ...@@ -155,7 +155,7 @@ Why can't I use an assignment in an expression?
Starting in Python 3.8, you can! 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:: expression::
while chunk := fp.read(200): while chunk := fp.read(200):
......
...@@ -1109,7 +1109,7 @@ Enum Classes ...@@ -1109,7 +1109,7 @@ Enum Classes
The :class:`EnumType` metaclass is responsible for providing the The :class:`EnumType` metaclass is responsible for providing the
:meth:`__contains__`, :meth:`__dir__`, :meth:`__iter__` and other methods that :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 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` responsible for ensuring that various other methods on the final :class:`Enum`
class are correct (such as :meth:`__new__`, :meth:`__getnewargs__`, class are correct (such as :meth:`__new__`, :meth:`__getnewargs__`,
:meth:`__str__` and :meth:`__repr__`). :meth:`__str__` and :meth:`__repr__`).
......
...@@ -562,7 +562,7 @@ To run a logging listener in production, you may need to use a process-managemen ...@@ -562,7 +562,7 @@ To run a logging listener in production, you may need to use a process-managemen
such as `Supervisor <http://supervisord.org/>`_. `Here such as `Supervisor <http://supervisord.org/>`_. `Here
<https://gist.github.com/vsajip/4b227eeec43817465ca835ca66f75e2b>`_ is a Gist which <https://gist.github.com/vsajip/4b227eeec43817465ca835ca66f75e2b>`_ is a Gist which
provides the bare-bones files to run the above functionality using Supervisor: you 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. want to use.
...@@ -2774,7 +2774,7 @@ Formatting times using UTC (GMT) via configuration ...@@ -2774,7 +2774,7 @@ Formatting times using UTC (GMT) via configuration
-------------------------------------------------- --------------------------------------------------
Sometimes you want to format times using UTC, which can be done using a class 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 logging
import time import time
......
...@@ -555,14 +555,14 @@ raw message. If there is no date format string, the default date format is: ...@@ -555,14 +555,14 @@ raw message. If there is no date format string, the default date format is:
%Y-%m-%d %H:%M:%S %Y-%m-%d %H:%M:%S
with the milliseconds tacked on at the end. The ``style`` is one of `%`, '{' 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. ``'{'``, 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 ``%(<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 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`. should conform to what is expected by :meth:`string.Template.substitute`.
.. versionchanged:: 3.2 .. versionchanged:: 3.2
......
...@@ -151,7 +151,7 @@ Enabling perf profiling mode ...@@ -151,7 +151,7 @@ Enabling perf profiling mode
---------------------------- ----------------------------
There are two main ways to activate the perf profiling mode. If you want it to be There are two main ways to activate the perf profiling mode. If you want it to be
active since the start of the Python interpreter, you can use the `-Xperf` option: active since the start of the Python interpreter, you can use the ``-Xperf`` option:
$ python -Xperf my_script.py $ python -Xperf my_script.py
......
...@@ -765,7 +765,7 @@ And on Windows, the configuration files are: ...@@ -765,7 +765,7 @@ And on Windows, the configuration files are:
+--------------+-------------------------------------------------+-------+ +--------------+-------------------------------------------------+-------+
On all platforms, the "personal" file can be temporarily disabled by On all platforms, the "personal" file can be temporarily disabled by
passing the `--no-user-cfg` option. passing the ``--no-user-cfg`` option.
Notes: Notes:
......
...@@ -553,7 +553,7 @@ accept factories that return streaming protocols. ...@@ -553,7 +553,7 @@ accept factories that return streaming protocols.
a connection is open. a connection is open.
However, :meth:`protocol.eof_received() <Protocol.eof_received>` 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. ``data_received()`` is not called anymore.
.. method:: Protocol.eof_received() .. method:: Protocol.eof_received()
......
...@@ -631,7 +631,7 @@ Timeouts ...@@ -631,7 +631,7 @@ Timeouts
Change the time the timeout will trigger. 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. context manager will wait indefinitely.
If *when* is a float, it is set as the new deadline. If *when* is a float, it is set as the new deadline.
...@@ -867,17 +867,17 @@ Running in Threads ...@@ -867,17 +867,17 @@ Running in Threads
# blocking_io complete at 19:50:54 # blocking_io complete at 19:50:54
# finished main 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, 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. blocking the event loop.
.. note:: .. 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 to make IO-bound functions non-blocking. However, for extension modules
that release the GIL or alternative Python implementations that don't 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 .. versionadded:: 3.9
......
...@@ -143,7 +143,7 @@ The :mod:`bdb` module also defines two classes: ...@@ -143,7 +143,7 @@ The :mod:`bdb` module also defines two classes:
For real file names, the canonical form is an operating-system-dependent, For real file names, the canonical form is an operating-system-dependent,
:func:`case-normalized <os.path.normcase>` :func:`absolute path :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. generated in interactive mode, is returned unchanged.
.. method:: reset() .. method:: reset()
......
...@@ -206,7 +206,7 @@ Incremental (de)compression ...@@ -206,7 +206,7 @@ Incremental (de)compression
will be set to ``True``. will be set to ``True``.
Attempting to decompress data after the end of stream is reached 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. stream is ignored and saved in the :attr:`~.unused_data` attribute.
.. versionchanged:: 3.5 .. versionchanged:: 3.5
...@@ -303,7 +303,7 @@ Using :class:`BZ2Compressor` for incremental compression: ...@@ -303,7 +303,7 @@ Using :class:`BZ2Compressor` for incremental compression:
>>> out = out + comp.flush() >>> out = out + comp.flush()
The example above uses a very "nonrandom" stream of data 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. while ordered, repetitive data usually yields a high compression ratio.
Writing and reading a bzip2-compressed file in binary mode: Writing and reading a bzip2-compressed file in binary mode:
......
...@@ -152,7 +152,7 @@ And:: ...@@ -152,7 +152,7 @@ And::
All threads enqueued to ``ThreadPoolExecutor`` will be joined before the All threads enqueued to ``ThreadPoolExecutor`` will be joined before the
interpreter can exit. Note that the exit handler which does this is 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 exceptions in the main thread must be caught and handled in order to
signal threads to exit gracefully. For this reason, it is recommended signal threads to exit gracefully. For this reason, it is recommended
that ``ThreadPoolExecutor`` not be used for long-running tasks. that ``ThreadPoolExecutor`` not be used for long-running tasks.
...@@ -411,13 +411,13 @@ The :class:`Future` class encapsulates the asynchronous execution of a callable. ...@@ -411,13 +411,13 @@ The :class:`Future` class encapsulates the asynchronous execution of a callable.
tests. tests.
If the method returns ``False`` then the :class:`Future` was cancelled, 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 waiting on the :class:`Future` completing (i.e. through
:func:`as_completed` or :func:`wait`) will be woken up. :func:`as_completed` or :func:`wait`) will be woken up.
If the method returns ``True`` then the :class:`Future` was not cancelled If the method returns ``True`` then the :class:`Future` was not cancelled
and has been put in the running state, i.e. calls to 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 This method can only be called once and cannot be called after
:meth:`Future.set_result` or :meth:`Future.set_exception` have been :meth:`Future.set_result` or :meth:`Future.set_exception` have been
......
...@@ -1948,7 +1948,7 @@ Utility functions ...@@ -1948,7 +1948,7 @@ Utility functions
.. function:: GetLastError() .. function:: GetLastError()
Windows only: Returns the last error code set by Windows in the calling thread. 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. it does not return the ctypes-private copy of the error code.
.. function:: get_errno() .. function:: get_errno()
......
...@@ -275,7 +275,7 @@ The module :mod:`curses` defines the following functions: ...@@ -275,7 +275,7 @@ The module :mod:`curses` defines the following functions:
Change the definition of a color, taking the number of the color to be changed 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 followed by three RGB values (for the amounts of red, green, and blue
components). The value of *color_number* must be between ``0`` and 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 ``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 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``. most terminals; it is active only if :func:`can_change_color` returns ``True``.
......
...@@ -1769,7 +1769,7 @@ Other constructor: ...@@ -1769,7 +1769,7 @@ Other constructor:
ISO 8601 format, with the following exceptions: ISO 8601 format, with the following exceptions:
1. Time zone offsets may have fractional seconds. 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. a date and a time, is not required.
3. Fractional seconds may have any number of digits (anything beyond 6 will 3. Fractional seconds may have any number of digits (anything beyond 6 will
be truncated). be truncated).
...@@ -2265,7 +2265,7 @@ where historical changes have been made to civil time. ...@@ -2265,7 +2265,7 @@ where historical changes have been made to civil time.
two digits of ``offset.hours`` and ``offset.minutes`` respectively. two digits of ``offset.hours`` and ``offset.minutes`` respectively.
.. versionchanged:: 3.6 .. 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'``. ``'UTC+00:00'``.
......
...@@ -576,11 +576,11 @@ Decimal objects ...@@ -576,11 +576,11 @@ Decimal objects
Alternative constructor that only accepts instances of :class:`float` or Alternative constructor that only accepts instances of :class:`float` or
:class:`int`. :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 Since 0.1 is not exactly representable in binary floating point, the
value is stored as the nearest representable value which is value is stored as the nearest representable value which is
`0x1.999999999999ap-4`. That equivalent value in decimal is ``0x1.999999999999ap-4``. That equivalent value in decimal is
`0.1000000000000000055511151231257827021181583404541015625`. ``0.1000000000000000055511151231257827021181583404541015625``.
.. note:: From Python 3.2 onwards, a :class:`Decimal` instance .. note:: From Python 3.2 onwards, a :class:`Decimal` instance
can also be constructed directly from a :class:`float`. can also be constructed directly from a :class:`float`.
...@@ -1209,7 +1209,7 @@ In addition to the three supplied contexts, new contexts can be created with the ...@@ -1209,7 +1209,7 @@ In addition to the three supplied contexts, new contexts can be created with the
.. method:: exp(x) .. method:: exp(x)
Returns `e ** x`. Returns ``e ** x``.
.. method:: fma(x, y, z) .. method:: fma(x, y, z)
......
...@@ -367,7 +367,7 @@ details of bytecode instructions as :class:`Instruction` instances: ...@@ -367,7 +367,7 @@ details of bytecode instructions as :class:`Instruction` instances:
.. class:: Positions .. 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:: lineno
.. data:: end_lineno .. data:: end_lineno
......
...@@ -298,7 +298,7 @@ Here are the methods of the :class:`Message` class: ...@@ -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 In a model generated from bytes, any header values that (in contravention of
the RFCs) contain non-ASCII bytes will, when retrieved through this the RFCs) contain non-ASCII bytes will, when retrieved through this
interface, be represented as :class:`~email.header.Header` objects with interface, be represented as :class:`~email.header.Header` objects with
a charset of `unknown-8bit`. a charset of ``unknown-8bit``.
.. method:: __len__() .. method:: __len__()
......
...@@ -153,7 +153,7 @@ headers. ...@@ -153,7 +153,7 @@ headers.
specified as ``-0000`` (indicating it is in UTC but contains no specified as ``-0000`` (indicating it is in UTC but contains no
information about the source timezone), then :attr:`.datetime` will be a information about the source timezone), then :attr:`.datetime` will be a
naive :class:`~datetime.datetime`. If a specific timezone offset is 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 ``datetime`` that uses :class:`datetime.timezone` to record the timezone
offset. offset.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment