summaryrefslogtreecommitdiffstats
path: root/Doc/howto
diff options
context:
space:
mode:
authorHugo van Kemenade <hugovk@users.noreply.github.com>2022-10-07 01:01:30 (GMT)
committerGitHub <noreply@github.com>2022-10-07 01:01:30 (GMT)
commitfa2d43e5184f5eaf3391844ec2400342a1b2ead4 (patch)
treefaa2f2ae684d96fd9bd81e5bc28a99bf96274254 /Doc/howto
parent27025e158c70331d0a8fb42fe234a2a6770850d1 (diff)
downloadcpython-fa2d43e5184f5eaf3391844ec2400342a1b2ead4.zip
cpython-fa2d43e5184f5eaf3391844ec2400342a1b2ead4.tar.gz
cpython-fa2d43e5184f5eaf3391844ec2400342a1b2ead4.tar.bz2
Docs: Fix backtick errors found by sphinx-lint (#97998)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Diffstat (limited to 'Doc/howto')
-rw-r--r--Doc/howto/enum.rst2
-rw-r--r--Doc/howto/logging-cookbook.rst4
-rw-r--r--Doc/howto/logging.rst10
-rw-r--r--Doc/howto/perf_profiling.rst2
4 files changed, 9 insertions, 9 deletions
diff --git a/Doc/howto/enum.rst b/Doc/howto/enum.rst
index 376934a..03f0565 100644
--- a/Doc/howto/enum.rst
+++ b/Doc/howto/enum.rst
@@ -1109,7 +1109,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__`).
diff --git a/Doc/howto/logging-cookbook.rst b/Doc/howto/logging-cookbook.rst
index ff7ba07..913502e 100644
--- a/Doc/howto/logging-cookbook.rst
+++ b/Doc/howto/logging-cookbook.rst
@@ -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
<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.
@@ -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
-such as `UTCFormatter`, shown below::
+such as ``UTCFormatter``, shown below::
import logging
import time
diff --git a/Doc/howto/logging.rst b/Doc/howto/logging.rst
index 0caff13..145449b 100644
--- a/Doc/howto/logging.rst
+++ b/Doc/howto/logging.rst
@@ -555,14 +555,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
diff --git a/Doc/howto/perf_profiling.rst b/Doc/howto/perf_profiling.rst
index ed8de88..387fb3f 100644
--- a/Doc/howto/perf_profiling.rst
+++ b/Doc/howto/perf_profiling.rst
@@ -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
-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