8000 gh-101100: Fix Sphinx warnings in `whatsnew/2.7.rst` and related (#11… · python/cpython@92483b2 · GitHub
[go: up one dir, main page]

Skip to content

Commit 92483b2

Browse files 10000
hugovkAlexWaygood
andauthored
gh-101100: Fix Sphinx warnings in whatsnew/2.7.rst and related (#115319)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
1 parent 705c76d commit 92483b2

File tree

9 files changed

+119
-100
lines changed

9 files changed

+119
-100
lines changed

Doc/library/asyncio-protocol.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -417,8 +417,8 @@ Subprocess Transports
417417

418418
Stop the subprocess.
419419

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

424424
See also :meth:`subprocess.Popen.terminate`.

Doc/library/asyncio-subprocess.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ their completion.
240240

241241
.. note::
242242

243-
On Windows, :py:data:`SIGTERM` is an alias for :meth:`terminate`.
243+
On Windows, :py:const:`~signal.SIGTERM` is an alias for :meth:`terminate`.
244244
``CTRL_C_EVENT`` and ``CTRL_BREAK_EVENT`` can be sent to processes
245245
started with a *creationflags* parameter which includes
246246
``CREATE_NEW_PROCESS_GROUP``.
@@ -249,10 +249,10 @@ their completion.
249249

250250
Stop the child process.
251251

252-
On POSIX systems this method sends :py:const:`signal.SIGTERM` to the
252+
On POSIX systems this method sends :py:const:`~signal.SIGTERM` to the
253253
child process.
254254

255-
On Windows the Win32 API function :c:func:`TerminateProcess` is
255+
On Windows the Win32 API function :c:func:`!TerminateProcess` is
256256
called to stop the child process.
257257

258258
.. method:: kill()

Doc/library/msvcrt.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,3 +252,18 @@ Other Functions
252252
.. data:: CRTDBG_REPORT_MODE
253253

254254
Returns current *mode* for the specified *type*.
255+
256+
257+
.. data:: CRT_ASSEMBLY_VERSION
258+
259+
The CRT Assembly version, from the :file:`crtassem.h` header file.
260+
261+
262+
.. data:: VC_ASSEMBLY_PUBLICKEYTOKEN
263+
264+
The VC Assembly public key token, from the :file:`crtassem.h` header file.
265+
266+
267+
.. data:: LIBRARIES_ASSEMBLY_NAME_PREFIX
268+
269+
The Libraries Assembly name prefix, from the :file:`crtassem.h` header file.

Doc/library/multiprocessing.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -649,8 +649,8 @@ The :mod:`multiprocessing` package mostly replicates the API of the
649649

650650
.. method:: terminate()
651651

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

656656
Note that descendant processes of the process will *not* be terminated --

Doc/library/subprocess.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -857,8 +857,8 @@ Instances of the :class:`Popen` class have the following methods:
857857

858858
.. method:: Popen.terminate()
859859

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

864864

Doc/whatsnew/2.6.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2388,11 +2388,11 @@ changes, or look through the Subversion logs for all the details.
23882388
using the format character ``'?'``.
23892389
(Contributed by David Remahl.)
23902390

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

23982398
* A new variable in the :mod:`sys` module, :attr:`float_info`, is an

Doc/whatsnew/2.7.rst

Lines changed: 87 additions & 83 deletions
Large diffs are not rendered by default.

Doc/whatsnew/3.1.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ Some smaller changes made to the core Python language are:
169169
... if '<critical>' in line:
170170
... outfile.write(line)
171171

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

175175
(Contributed by Georg Brandl and Mattias Brändström;

Doc/whatsnew/3.2.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -743,8 +743,8 @@ Several new and useful functions and methods have been added:
743743

744744
Two methods have been deprecated:
745745

746-
* :meth:`xml.etree.ElementTree.getchildren` use ``list(elem)`` instead.
747-
* :meth:`xml.etree.ElementTree.getiterator` use ``Element.iter`` instead.
746+
* :meth:`!xml.etree.ElementTree.getchildren` use ``list(elem)`` instead.
747+
* :meth:`!xml.etree.ElementTree.getiterator` use ``Element.iter`` instead.
748748

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

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

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

0 commit comments

Comments
 (0)
0