8000 [3.11] Docs: Fix backtick errors found by sphinx-lint (GH-97998) · CAM-Gerlach/cpython@a6ea2cc · GitHub
[go: up one dir, main page]
Skip to content

Commit a6ea2cc

Browse files
hugovkCAM-Gerlach
hugovk
authored and
CAM-Gerlach
committed
[3.11] Docs: Fix backtick errors found by sphinx-lint (pythonGH-97998)
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>
1 parent 211b819 commit a6ea2cc

Some content is hidden

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

50 files changed

+86
-94
lines changed

‎Doc/c-api/init.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1796,7 +1796,7 @@ is not possible due to its implementation being opaque at build time.
17961796
Free the given *key* allocated by :c:func:`PyThread_tss_alloc`, after
17971797
first calling :c:func:`PyThread_tss_delete` to ensure any associated
17981798
thread locals have been unassigned. This is a no-op if the *key*
1799-
argument is `NULL`.
1799+
argument is ``NULL``.
18001800
18011801
.. note::
18021802
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
@@ -1120,7 +1120,7 @@ Enum Classes
11201120
The :class:`EnumType` metaclass is responsible for providing the
11211121
:meth:`__contains__`, :meth:`__dir__`, :meth:`__iter__` and other methods that
11221122
allow one to do things with an :class:`Enum` class that fail on a typical
1123-
class, such as `list(Color)` or `some_enum_var in Color`. :class:`EnumType` is
1123+
class, such as ``list(Color)`` or ``some_enum_var in Color``. :class:`EnumType` is
11241124
responsible for ensuring that various other methods on the final :class:`Enum`
11251125
class are correct (such as :meth:`__new__`, :meth:`__getnewargs__`,
11261126
:meth:`__str__` and :meth:`__repr__`).

‎Doc/howto/logging-cookbook.rst

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

775775

@@ -2981,7 +2981,7 @@ Formatting times using UTC (GMT) via configuration
29812981
--------------------------------------------------
29822982

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

29862986
import logging
29872987
import time

‎Doc/howto/logging.rst

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

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

565565
.. versionchanged:: 3.2

‎Doc/install/index.rst

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

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

766766
Notes:
767767

‎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
< F462 /code>
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

‎Doc/library/bdb.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ The :mod:`bdb` module also defines two classes:
143143

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

149149
.. method:: reset()

0 commit comments

Comments
 (0)
0