[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
This commit is contained in:
Hugo van Kemenade 2022-10-20 15:07:33 +02:00 committed by GitHub
parent 860efa3534
commit 095e06f4ca
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 5 additions and 8 deletions

View file

@ -1800,7 +1800,7 @@ is not possible due to its implementation being opaque at build time.
.. 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
`NULL`. ``NULL``.
Methods Methods

View file

@ -57,7 +57,7 @@ await on multiple things with timeouts.
- Monitor for completion. - Monitor for completion.
* - :func:`timeout` * - :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` * - :func:`to_thread`
- Asynchronously run a function in a separate OS thread. - Asynchronously run a function in a separate OS thread.

View file

@ -391,7 +391,7 @@ Pure paths provide the following methods and properties:
If you want to walk an arbitrary filesystem path upwards, it is If you want to walk an arbitrary filesystem path upwards, it is
recommended to first call :meth:`Path.resolve` so as to resolve recommended to first call :meth:`Path.resolve` so as to resolve
symlinks and eliminate `".."` components. symlinks and eliminate ``".."`` components.
.. data:: PurePath.name .. data:: PurePath.name

View file

@ -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 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* 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() .. method:: Popen.terminate()

View file

@ -7,10 +7,7 @@ sphinx==4.5.0
blurb blurb
# sphinx-lint 0.6.2 yields many default role errors due to the new regular sphinx-lint==0.6.7
# expression used for default role detection, so we don't use the version
# until the errors are fixed.
sphinx-lint==0.6.4
# The theme used by the documentation is stored separately, so we need # The theme used by the documentation is stored separately, so we need
# to install that as well. # to install that as well.