Skip to content

Commit fa2d43e

Browse files
hugovkezio-melotti
hugovk
and
ezio-melotti
authored
Docs: Fix backtick errors found by sphinx-lint (#97998)
Co-authored-by: Ezio Melotti <[email protected]>
1 parent 27025e1 commit fa2d43e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+90
-98
lines changed

‎Doc/c-api/init.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1929,7 +1929,7 @@ is not possible due to its implementation being opaque at build time.
19291929
Free the given *key* allocated by :c:func:`PyThread_tss_alloc`, after
19301930
first calling :c:func:`PyThread_tss_delete` to ensure any associated
19311931
thread locals have been unassigned. This is a no-op if the *key*
1932-
argument is `NULL`.
1932+
argument is ``NULL``.
19331933
19341934
.. note::
19351935
A freed key becomes a dangling pointer. You should reset the key to

‎Doc/c-api/type.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Type Objects
4040
.. c:function:: unsigned long PyType_GetFlags(PyTypeObject* type)
4141
4242
Return the :c:member:`~PyTypeObject.tp_flags` member of *type*. This function is primarily
43-
meant for use with `Py_LIMITED_API`; the individual flag bits are
43+
meant for use with ``Py_LIMITED_API``; the individual flag bits are
4444
guaranteed to be stable across Python releases, but access to
4545
:c:member:`~PyTypeObject.tp_flags` itself is not part of the limited API.
4646

‎Doc/faq/design.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ Why can't I use an assignment in an expression?
155155

156156
Starting in Python 3.8, you can!
157157

158-
Assignment expressions using the walrus operator `:=` assign a variable in an
158+
Assignment expressions using the walrus operator ``:=`` assign a variable in an
159159
expression::
160160

161161
while chunk := fp.read(200):

‎Doc/howto/enum.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1109,7 +1109,7 @@ Enum Classes
11091109
The :class:`EnumType` metaclass is responsible for providing the
11101110
:meth:`__contains__`, :meth:`__dir__`, :meth:`__iter__` and other methods that
11111111
allow one to do things with an :class:`Enum` class that fail on a typical
1112-
class, such as `list(Color)` or `some_enum_var in Color`. :class:`EnumType` is
1112+
class, such as ``list(Color)`` or ``some_enum_var in Color``. :class:`EnumType` is
11131113
responsible for ensuring that various other methods on the final :class:`Enum`
11141114
class are correct (such as :meth:`__new__`, :meth:`__getnewargs__`,
11151115
:meth:`__str__` and :meth:`__repr__`).

‎Doc/howto/logging-cookbook.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -562,7 +562,7 @@ To run a logging listener in production, you may need to use a process-managemen
562562
such as `Supervisor <http://supervisord.org/>`_. `Here
563563
<https://gist.github.com/vsajip/4b227eeec43817465ca835ca66f75e2b>`_ is a Gist which
564564
provides the bare-bones files to run the above functionality using Supervisor: you
565-
will need to change the `/path/to/` parts in the Gist to reflect the actual paths you
565+
will need to change the ``/path/to/`` parts in the Gist to reflect the actual paths you
566566
want to use.
567567

568568

@@ -2774,7 +2774,7 @@ Formatting times using UTC (GMT) via configuration
27742774
--------------------------------------------------
27752775

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

27792779
import logging
27802780
import time

‎Doc/howto/logging.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -555,14 +555,14 @@ raw message. If there is no date format string, the default date format is:
555555
556556
%Y-%m-%d %H:%M:%S
557557
558-
with the milliseconds tacked on at the end. The ``style`` is one of `%`, '{'
559-
or '$'. If one of these is not specified, then '%' will be used.
558+
with the milliseconds tacked on at the end. The ``style`` is one of ``'%'``,
559+
``'{'``, or ``'$'``. If one of these is not specified, then ``'%'`` will be used.
560560

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

568568
.. versionchanged:: 3.2

‎Doc/howto/perf_profiling.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ Enabling perf profiling mode
151151
----------------------------
152152

153153
There are two main ways to activate the perf profiling mode. If you want it to be
154-
active since the start of the Python interpreter, you can use the `-Xperf` option:
154+
active since the start of the Python interpreter, you can use the ``-Xperf`` option:
155155

156156
$ python -Xperf my_script.py
157157

‎Doc/install/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -765,7 +765,7 @@ And on Windows, the configuration files are:
765765
+--------------+-------------------------------------------------+-------+
766766

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

770770
Notes:
771771

‎Doc/library/asyncio-protocol.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -553,7 +553,7 @@ accept factories that return streaming protocols.
553553
a connection is open.
554554

555555
However, :meth:`protocol.eof_received() <Protocol.eof_received>`
556-
is called at most once. Once `eof_received()` is called,
556+
is called at most once. Once ``eof_received()`` is called,
557557
``data_received()`` is not called anymore.
558558

559559
.. method:: Protocol.eof_received()

‎Doc/library/asyncio-task.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -631,7 +631,7 @@ Timeouts
631631

632632
Change the time the timeout will trigger.
633633

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

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

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

875875
.. note::
876876

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

882882
.. versionadded:: 3.9
883883

0 commit comments

Comments
 (0)