[Python-checkins] [3.11] Docs: Bump sphinx-lint and use double backticks for inline literals (GH-98441) (#98445)

ezio-melotti webhook-mailer at python.org
Thu Oct 20 09:08:12 EDT 2022


https://github.com/python/cpython/commit/095e06f4ca8715e117182b34cd668d77de9857e4
commit: 095e06f4ca8715e117182b34cd668d77de9857e4
branch: 3.11
author: Hugo van Kemenade <hugovk at users.noreply.github.com>
committer: ezio-melotti <ezio.melotti at gmail.com>
date: 2022-10-20T06:07:33-07:00
summary:

[3.11] Docs: Bump sphinx-lint and use double backticks for inline literals (GH-98441) (#98445)

Bump sphinx-lint and use double backticks for inline literals

files:
M Doc/c-api/init.rst
M Doc/library/asyncio-api-index.rst
M Doc/library/pathlib.rst
M Doc/library/subprocess.rst
M Doc/requirements.txt

diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst
index 511d24da4fb7..55c05096ae91 100644
--- a/Doc/c-api/init.rst
+++ b/Doc/c-api/init.rst
@@ -1800,7 +1800,7 @@ is not possible due to its implementation being opaque at build time.
 
    .. note::
       A freed key becomes a dangling pointer. You should reset the key to
-      `NULL`.
+      ``NULL``.
 
 
 Methods
diff --git a/Doc/library/asyncio-api-index.rst b/Doc/library/asyncio-api-index.rst
index 54c1cd6582e4..ad475150fe7d 100644
--- a/Doc/library/asyncio-api-index.rst
+++ b/Doc/library/asyncio-api-index.rst
@@ -57,7 +57,7 @@ await on multiple things with timeouts.
       - Monitor for completion.
 
     * - :func:`timeout`
-      - Run with a timeout. Useful in cases when `wait_for` is not suitable.
+      - Run with a timeout. Useful in cases when ``wait_for`` is not suitable.
 
     * - :func:`to_thread`
       - Asynchronously run a function in a separate OS thread.
diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst
index 5012150b86ce..843513c5fc54 100644
--- a/Doc/library/pathlib.rst
+++ b/Doc/library/pathlib.rst
@@ -391,7 +391,7 @@ Pure paths provide the following methods and properties:
 
       If you want to walk an arbitrary filesystem path upwards, it is
       recommended to first call :meth:`Path.resolve` so as to resolve
-      symlinks and eliminate `".."` components.
+      symlinks and eliminate ``".."`` components.
 
 
 .. data:: PurePath.name
diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst
index dee5bd879db5..51b9e38b7b6c 100644
--- a/Doc/library/subprocess.rst
+++ b/Doc/library/subprocess.rst
@@ -829,7 +829,7 @@ Instances of the :class:`Popen` class have the following methods:
 
       On Windows, SIGTERM is an alias for :meth:`terminate`. CTRL_C_EVENT and
       CTRL_BREAK_EVENT can be sent to processes started with a *creationflags*
-      parameter which includes `CREATE_NEW_PROCESS_GROUP`.
+      parameter which includes ``CREATE_NEW_PROCESS_GROUP``.
 
 
 .. method:: Popen.terminate()
diff --git a/Doc/requirements.txt b/Doc/requirements.txt
index 7f82dc32113a..958665db69e2 100644
--- a/Doc/requirements.txt
+++ b/Doc/requirements.txt
@@ -7,10 +7,7 @@ sphinx==4.5.0
 
 blurb
 
-# sphinx-lint 0.6.2 yields many default role errors due to the new regular
-# expression used for default role detection, so we don't use the version
-# until the errors are fixed.
-sphinx-lint==0.6.4
+sphinx-lint==0.6.7
 
 # The theme used by the documentation is stored separately, so we need
 # to install that as well.



More information about the Python-checkins mailing list