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

gh-101100: Fix Sphinx warnings in whatsnew/2.7.rst and related #115319

Merged
merged 7 commits into from
Feb 12, 2024
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions Doc/library/asyncio-protocol.rst
Original file line number Diff line number Diff line change
Expand Up @@ -417,8 +417,8 @@ Subprocess Transports

Stop the subprocess.

On POSIX systems, this method sends SIGTERM to the subprocess.
On Windows, the Windows API function TerminateProcess() is called to
On POSIX systems, this method sends :py:const:`~signal.SIGTERM` to the subprocess.
On Windows, the Windows API function :c:func:`!TerminateProcess` is called to
stop the subprocess.

See also :meth:`subprocess.Popen.terminate`.
Expand Down
6 changes: 3 additions & 3 deletions Doc/library/asyncio-subprocess.rst
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ their completion.

.. note::

On Windows, :py:data:`SIGTERM` is an alias for :meth:`terminate`.
On Windows, :py:const:`~signal.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``.
Expand All @@ -249,10 +249,10 @@ their completion.

Stop the child process.

On POSIX systems this method sends :py:const:`signal.SIGTERM` to the
On POSIX systems this method sends :py:const:`~signal.SIGTERM` to the
child process.

On Windows the Win32 API function :c:func:`TerminateProcess` is
On Windows the Win32 API function :c:func:`!TerminateProcess` is
called to stop the child process.

.. method:: kill()
Expand Down
15 changes: 15 additions & 0 deletions Doc/library/msvcrt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -252,3 +252,18 @@ Other Functions
.. data:: CRTDBG_REPORT_MODE

Returns current *mode* for the specified *type*.


.. data:: CRT_ASSEMBLY_VERSION

The CRT Assembly version, from the :file:`crtassem.h` header file.


.. data:: VC_ASSEMBLY_PUBLICKEYTOKEN

The VC Assembly public key token, from the :file:`crtassem.h` header file.


.. data:: LIBRARIES_ASSEMBLY_NAME_PREFIX

The Libraries Assembly name prefix, from the :file:`crtassem.h` header file.
4 changes: 2 additions & 2 deletions Doc/library/multiprocessing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -649,8 +649,8 @@ The :mod:`multiprocessing` package mostly replicates the API of the

.. method:: terminate()

Terminate the process. On POSIX this is done using the ``SIGTERM`` signal;
on Windows :c:func:`TerminateProcess` is used. Note that exit handlers and
Terminate the process. On POSIX this is done using the :py:const:`~signal.SIGTERM` signal;
on Windows :c:func:`!TerminateProcess` is used. Note that exit handlers and
finally clauses, etc., will not be executed.

Note that descendant processes of the process will *not* be terminated --
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/subprocess.rst
Original file line number Diff line number Diff line change
Expand Up @@ -857,8 +857,8 @@ Instances of the :class:`Popen` class have the following methods:

.. method:: Popen.terminate()

Stop the child. On POSIX OSs the method sends SIGTERM to the
child. On Windows the Win32 API function :c:func:`TerminateProcess` is called
Stop the child. On POSIX OSs the method sends :py:const:`~signal.SIGTERM` to the
child. On Windows the Win32 API function :c:func:`!TerminateProcess` is called
to stop the child.


Expand Down
8 changes: 4 additions & 4 deletions Doc/whatsnew/2.6.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2388,11 +2388,11 @@ changes, or look through the Subversion logs for all the details.
using the format character ``'?'``.
(Contributed by David Remahl.)

* The :class:`Popen` objects provided by the :mod:`subprocess` module
now have :meth:`terminate`, :meth:`kill`, and :meth:`send_signal` methods.
On Windows, :meth:`send_signal` only supports the :const:`SIGTERM`
* The :class:`~subprocess.Popen` objects provided by the :mod:`subprocess` module
now have :meth:`~subprocess.Popen.terminate`, :meth:`~subprocess.Popen.kill`, and :meth:`~subprocess.Popen.send_signal` methods.
On Windows, :meth:`!send_signal` only supports the :py:const:`~signal.SIGTERM`
signal, and all these methods are aliases for the Win32 API function
:c:func:`TerminateProcess`.
:c:func:`!TerminateProcess`.
(Contributed by Christian Heimes.)

* A new variable in the :mod:`sys` module, :attr:`float_info`, is an
Expand Down
170 changes: 87 additions & 83 deletions Doc/whatsnew/2.7.rst

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion Doc/whatsnew/3.1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ Some smaller changes made to the core Python language are:
... if '<critical>' in line:
... outfile.write(line)

With the new syntax, the :func:`contextlib.nested` function is no longer
With the new syntax, the :func:`!contextlib.nested` function is no longer
needed and is now deprecated.

(Contributed by Georg Brandl and Mattias Brändström;
Expand Down
6 changes: 3 additions & 3 deletions Doc/whatsnew/3.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -743,8 +743,8 @@ Several new and useful functions and methods have been added:

Two methods have been deprecated:

* :meth:`xml.etree.ElementTree.getchildren` use ``list(elem)`` instead.
* :meth:`xml.etree.ElementTree.getiterator` use ``Element.iter`` instead.
* :meth:`!xml.etree.ElementTree.getchildren` use ``list(elem)`` instead.
* :meth:`!xml.etree.ElementTree.getiterator` use ``Element.iter`` instead.

For details of the update, see `Introducing ElementTree
<https://web.archive.org/web/20200703234532/http://effbot.org/zone/elementtree-13-intro.htm>`_
Expand Down Expand Up @@ -2682,7 +2682,7 @@ require changes to your code:

(Contributed by Georg Brandl; :issue:`5675`.)

* The previously deprecated :func:`contextlib.nested` function has been removed
* The previously deprecated :func:`!contextlib.nested` function has been removed
in favor of a plain :keyword:`with` statement which can accept multiple
context managers. The latter technique is faster (because it is built-in),
and it does a better job finalizing multiple context managers when one of them
Expand Down