Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Oct 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Doc/c-api/init.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/asyncio-api-index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/pathlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/subprocess.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
5 changes: 1 addition & 4 deletions Doc/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down