Skip to content

Commit 666a360

Browse files
authored
[3.12] gh-101100: Fix Sphinx warnings in whatsnew/3.9.rst (GH-118364) (#118365)
1 parent 186fbe8 commit 666a360

File tree

7 files changed

+37
-37
lines changed

7 files changed

+37
-37
lines changed

Doc/whatsnew/3.7.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -669,8 +669,8 @@ include:
669669
* The new :func:`asyncio.current_task` function returns the currently running
670670
:class:`~asyncio.Task` instance, and the new :func:`asyncio.all_tasks`
671671
function returns a set of all existing ``Task`` instances in a given loop.
672-
The :meth:`Task.current_task() <asyncio.Task.current_task>` and
673-
:meth:`Task.all_tasks() <asyncio.Task.all_tasks>` methods have been deprecated.
672+
The :meth:`!Task.current_task` and
673+
:meth:`!Task.all_tasks` methods have been deprecated.
674674
(Contributed by Andrew Svetlov in :issue:`32250`.)
675675

676676
* The new *provisional* :class:`~asyncio.BufferedProtocol` class allows
@@ -1969,7 +1969,7 @@ asynchronous context manager must be used in order to acquire and release
19691969
the synchronization resource.
19701970
(Contributed by Andrew Svetlov in :issue:`32253`.)
19711971

1972-
The :meth:`asyncio.Task.current_task` and :meth:`asyncio.Task.all_tasks`
1972+
The :meth:`!asyncio.Task.current_task` and :meth:`!asyncio.Task.all_tasks`
19731973
methods have been deprecated.
19741974
(Contributed by Andrew Svetlov in :issue:`32250`.)
19751975

Doc/whatsnew/3.9.rst

+24-24
Original file line numberDiff line numberDiff line change
@@ -81,13 +81,13 @@ Interpreter improvements:
8181
* a number of Python builtins (range, tuple, set, frozenset, list, dict) are
8282
now sped up using :pep:`590` vectorcall;
8383
* garbage collection does not block on resurrected objects;
84-
* a number of Python modules (:mod:`_abc`, :mod:`audioop`, :mod:`_bz2`,
85-
:mod:`_codecs`, :mod:`_contextvars`, :mod:`_crypt`, :mod:`_functools`,
86-
:mod:`_json`, :mod:`_locale`, :mod:`math`, :mod:`operator`, :mod:`resource`,
87-
:mod:`time`, :mod:`_weakref`) now use multiphase initialization as defined
84+
* a number of Python modules (:mod:`!_abc`, :mod:`audioop`, :mod:`!_bz2`,
85+
:mod:`!_codecs`, :mod:`!_contextvars`, :mod:`!_crypt`, :mod:`!_functools`,
86+
:mod:`!_json`, :mod:`!_locale`, :mod:`math`, :mod:`operator`, :mod:`resource`,
87+
:mod:`time`, :mod:`!_weakref`) now use multiphase initialization as defined
8888
by PEP 489;
8989
* a number of standard library modules (:mod:`audioop`, :mod:`ast`, :mod:`grp`,
90-
:mod:`_hashlib`, :mod:`pwd`, :mod:`_posixsubprocess`, :mod:`random`,
90+
:mod:`!_hashlib`, :mod:`pwd`, :mod:`!_posixsubprocess`, :mod:`random`,
9191
:mod:`select`, :mod:`struct`, :mod:`termios`, :mod:`zlib`) are now using
9292
the stable ABI defined by PEP 384.
9393

@@ -203,7 +203,7 @@ The :mod:`ast` module uses the new parser and produces the same AST as
203203
the old parser.
204204

205205
In Python 3.10, the old parser will be deleted and so will all
206-
functionality that depends on it (primarily the :mod:`parser` module,
206+
functionality that depends on it (primarily the :mod:`!parser` module,
207207
which has long been deprecated). In Python 3.9 *only*, you can switch
208208
back to the LL(1) parser using a command line switch (``-X
209209
oldparser``) or an environment variable (``PYTHONOLDPARSER=1``).
@@ -366,7 +366,7 @@ wait until the cancellation is complete also in the case when *timeout* is
366366
<= 0, like it does with positive timeouts.
367367
(Contributed by Elvis Pranskevichus in :issue:`32751`.)
368368

369-
:mod:`asyncio` now raises :exc:`TyperError` when calling incompatible
369+
:mod:`asyncio` now raises :exc:`TypeError` when calling incompatible
370370
methods with an :class:`ssl.SSLSocket` socket.
371371
(Contributed by Ido Michael in :issue:`37404`.)
372372

@@ -589,7 +589,7 @@ a non-blocking socket. (Contributed by Donghee Na in :issue:`39259`.)
589589
os
590590
--
591591

592-
Added :const:`~os.CLD_KILLED` and :const:`~os.CLD_STOPPED` for :attr:`si_code`.
592+
Added :const:`~os.CLD_KILLED` and :const:`~os.CLD_STOPPED` for :attr:`!si_code`.
593593
(Contributed by Donghee Na in :issue:`38493`.)
594594

595595
Exposed the Linux-specific :func:`os.pidfd_open` (:issue:`38692`) and
@@ -861,7 +861,7 @@ Deprecated
861861
Python versions it will raise a :exc:`TypeError` for all floats.
862862
(Contributed by Serhiy Storchaka in :issue:`37315`.)
863863

864-
* The :mod:`parser` and :mod:`symbol` modules are deprecated and will be
864+
* The :mod:`!parser` and :mod:`!symbol` modules are deprecated and will be
865865
removed in future versions of Python. For the majority of use cases,
866866
users can leverage the Abstract Syntax Tree (AST) generation and compilation
867867
stage, using the :mod:`ast` module.
@@ -889,7 +889,7 @@ Deprecated
889889
it for writing and silencing a warning.
890890
(Contributed by Serhiy Storchaka in :issue:`28286`.)
891891

892-
* Deprecated the ``split()`` method of :class:`_tkinter.TkappType` in
892+
* Deprecated the ``split()`` method of :class:`!_tkinter.TkappType` in
893893
favour of the ``splitlist()`` method which has more consistent and
894894
predicable behavior.
895895
(Contributed by Serhiy Storchaka in :issue:`38371`.)
@@ -898,11 +898,11 @@ Deprecated
898898
deprecated and will be removed in version 3.11.
899899
(Contributed by Yury Selivanov and Kyle Stanley in :issue:`34790`.)
900900

901-
* binhex4 and hexbin4 standards are now deprecated. The :mod:`binhex` module
901+
* binhex4 and hexbin4 standards are now deprecated. The :mod:`!binhex` module
902902
and the following :mod:`binascii` functions are now deprecated:
903903

904-
* :func:`~binascii.b2a_hqx`, :func:`~binascii.a2b_hqx`
905-
* :func:`~binascii.rlecode_hqx`, :func:`~binascii.rledecode_hqx`
904+
* :func:`!b2a_hqx`, :func:`!a2b_hqx`
905+
* :func:`!rlecode_hqx`, :func:`!rledecode_hqx`
906906

907907
(Contributed by Victor Stinner in :issue:`39353`.)
908908

@@ -950,7 +950,7 @@ Deprecated
950950
Removed
951951
=======
952952

953-
* The erroneous version at :data:`unittest.mock.__version__` has been removed.
953+
* The erroneous version at :data:`!unittest.mock.__version__` has been removed.
954954

955955
* :class:`nntplib.NNTP`: ``xpath()`` and ``xgtitle()`` methods have been removed.
956956
These methods are deprecated since Python 3.3. Generally, these extensions
@@ -987,7 +987,7 @@ Removed
987987
removed. They were deprecated since Python 3.7.
988988
(Contributed by Victor Stinner in :issue:`37320`.)
989989

990-
* The :meth:`~threading.Thread.isAlive()` method of :class:`threading.Thread`
990+
* The :meth:`!isAlive()` method of :class:`threading.Thread`
991991
has been removed. It was deprecated since Python 3.8.
992992
Use :meth:`~threading.Thread.is_alive()` instead.
993993
(Contributed by Donghee Na in :issue:`37804`.)
@@ -1035,7 +1035,7 @@ Removed
10351035
``asyncio.Condition`` and ``asyncio.Semaphore``.
10361036
(Contributed by Andrew Svetlov in :issue:`34793`.)
10371037

1038-
* The :func:`sys.getcounts` function, the ``-X showalloccount`` command line
1038+
* The :func:`!sys.getcounts` function, the ``-X showalloccount`` command line
10391039
option and the ``show_alloc_count`` field of the C structure
10401040
:c:type:`PyConfig` have been removed. They required a special Python build by
10411041
defining ``COUNT_ALLOCS`` macro.
@@ -1046,11 +1046,11 @@ Removed
10461046
the ``__annotations__`` attribute instead.
10471047
(Contributed by Serhiy Storchaka in :issue:`40182`.)
10481048

1049-
* The :meth:`symtable.SymbolTable.has_exec` method has been removed. It was
1049+
* The :meth:`!symtable.SymbolTable.has_exec` method has been removed. It was
10501050
deprecated since 2006, and only returning ``False`` when it's called.
10511051
(Contributed by Batuhan Taskaya in :issue:`40208`)
10521052

1053-
* The :meth:`asyncio.Task.current_task` and :meth:`asyncio.Task.all_tasks`
1053+
* The :meth:`!asyncio.Task.current_task` and :meth:`!asyncio.Task.all_tasks`
10541054
have been removed. They were deprecated since Python 3.7 and you can use
10551055
:func:`asyncio.current_task` and :func:`asyncio.all_tasks` instead.
10561056
(Contributed by Rémi Lapeyre in :issue:`40967`)
@@ -1230,7 +1230,7 @@ Build Changes
12301230
* The ``COUNT_ALLOCS`` special build macro has been removed.
12311231
(Contributed by Victor Stinner in :issue:`39489`.)
12321232

1233-
* On non-Windows platforms, the :c:func:`setenv` and :c:func:`unsetenv`
1233+
* On non-Windows platforms, the :c:func:`!setenv` and :c:func:`!unsetenv`
12341234
functions are now required to build Python.
12351235
(Contributed by Victor Stinner in :issue:`39395`.)
12361236

@@ -1319,7 +1319,7 @@ New Features
13191319
the garbage collector respectively.
13201320
(Contributed by Pablo Galindo Salgado in :issue:`40241`.)
13211321

1322-
* Added :c:func:`_PyObject_FunctionStr` to get a user-friendly string
1322+
* Added :c:func:`!_PyObject_FunctionStr` to get a user-friendly string
13231323
representation of a function-like object.
13241324
(Patch by Jeroen Demeyer in :issue:`37645`.)
13251325

@@ -1361,7 +1361,7 @@ Porting to Python 3.9
13611361
and refers to a constant string.
13621362
(Contributed by Serhiy Storchaka in :issue:`38650`.)
13631363

1364-
* The :c:type:`PyGC_Head` structure is now opaque. It is only defined in the
1364+
* The :c:type:`!PyGC_Head` structure is now opaque. It is only defined in the
13651365
internal C API (``pycore_gc.h``).
13661366
(Contributed by Victor Stinner in :issue:`40241`.)
13671367

@@ -1384,12 +1384,12 @@ Porting to Python 3.9
13841384

13851385
* :c:func:`PyObject_IS_GC` macro was converted to a function.
13861386

1387-
* The :c:func:`PyObject_NEW` macro becomes an alias to the
1388-
:c:macro:`PyObject_New` macro, and the :c:func:`PyObject_NEW_VAR` macro
1387+
* The :c:func:`!PyObject_NEW` macro becomes an alias to the
1388+
:c:macro:`PyObject_New` macro, and the :c:func:`!PyObject_NEW_VAR` macro
13891389
becomes an alias to the :c:macro:`PyObject_NewVar` macro. They no longer
13901390
access directly the :c:member:`PyTypeObject.tp_basicsize` member.
13911391

1392-
* :c:func:`PyObject_GET_WEAKREFS_LISTPTR` macro was converted to a function:
1392+
* :c:func:`!PyObject_GET_WEAKREFS_LISTPTR` macro was converted to a function:
13931393
the macro accessed directly the :c:member:`PyTypeObject.tp_weaklistoffset`
13941394
member.
13951395

Misc/NEWS.d/3.10.0a1.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1861,8 +1861,8 @@ bundled versions of ``pip`` and ``setuptools``. Patch by Krzysztof Konopko.
18611861
.. nonce: _dx3OO
18621862
.. section: Library
18631863
1864-
Removed :meth:`asyncio.Task.current_task` and
1865-
:meth:`asyncio.Task.all_tasks`. Patch contributed by Rémi Lapeyre.
1864+
Removed :meth:`!asyncio.Task.current_task` and
1865+
:meth:`!asyncio.Task.all_tasks`. Patch contributed by Rémi Lapeyre.
18661866

18671867
..
18681868

Misc/NEWS.d/3.11.0a4.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
:c:func:`Py_EndInterpreter` now explicitly untracks all objects currently
88
tracked by the GC. Previously, if an object was used later by another
99
interpreter, calling :c:func:`PyObject_GC_UnTrack` on the object crashed if
10-
the previous or the next object of the :c:type:`PyGC_Head` structure became
10+
the previous or the next object of the :c:type:`!PyGC_Head` structure became
1111
a dangling pointer. Patch by Victor Stinner.
1212

1313
..

Misc/NEWS.d/3.9.0a1.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -5616,7 +5616,7 @@ heap type
56165616
.. nonce: 4DcUaI
56175617
.. section: C API
56185618
5619-
Add :c:func:`_PyObject_FunctionStr` to get a user-friendly string
5619+
Add :c:func:`!_PyObject_FunctionStr` to get a user-friendly string
56205620
representation of a function-like object. Patch by Jeroen Demeyer.
56215621

56225622
..

Misc/NEWS.d/3.9.0a2.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -844,7 +844,7 @@ test.regrtest now can receive a list of test patterns to ignore (using the
844844
.. nonce: cNsA7S
845845
.. section: Build
846846
847-
:mod:`asyncio` now raises :exc:`TyperError` when calling incompatible
847+
:mod:`asyncio` now raises :exc:`TypeError` when calling incompatible
848848
methods with an :class:`ssl.SSLSocket` socket. Patch by Ido Michael.
849849

850850
..

Misc/NEWS.d/3.9.0a6.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -564,7 +564,7 @@ Implement traverse and clear slots in _abc._abc_data type.
564564
.. nonce: 3rO_q7
565565
.. section: Library
566566
567-
Remove deprecated :meth:`symtable.SymbolTable.has_exec`.
567+
Remove deprecated :meth:`!symtable.SymbolTable.has_exec`.
568568

569569
..
570570
@@ -1118,7 +1118,7 @@ into an exit code.
11181118
.. nonce: _FOf7E
11191119
.. section: C API
11201120
1121-
Move the :c:type:`PyGC_Head` structure to the internal C API.
1121+
Move the :c:type:`!PyGC_Head` structure to the internal C API.
11221122

11231123
..
11241124
@@ -1149,8 +1149,8 @@ the garbage collector respectively. Patch by Pablo Galindo.
11491149
.. nonce: Seuh3D
11501150
.. section: C API
11511151
1152-
The :c:func:`PyObject_NEW` macro becomes an alias to the
1153-
:c:func:`PyObject_New` macro, and the :c:func:`PyObject_NEW_VAR` macro
1152+
The :c:func:`!PyObject_NEW` macro becomes an alias to the
1153+
:c:func:`PyObject_New` macro, and the :c:func:`!PyObject_NEW_VAR` macro
11541154
becomes an alias to the :c:func:`PyObject_NewVar` macro, to hide
11551155
implementation details. They no longer access directly the
11561156
:c:member:`PyTypeObject.tp_basicsize` member.
@@ -1174,7 +1174,7 @@ used.
11741174
.. nonce: 6nFYbY
11751175
.. section: C API
11761176
1177-
Convert the :c:func:`PyObject_GET_WEAKREFS_LISTPTR` macro to a function to
1177+
Convert the :c:func:`!PyObject_GET_WEAKREFS_LISTPTR` macro to a function to
11781178
hide implementation details: the macro accessed directly to the
11791179
:c:member:`PyTypeObject.tp_weaklistoffset` member.
11801180

0 commit comments

Comments
 (0)