Skip to content

Commit 377ff9d

Browse files
hugovkAlexWaygood
andauthored
[3.12] NEWS: Fix Sphinx warnings and increase threshold for new news nits (GH-121482) (#121514)
Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Alex Waygood <[email protected]>
1 parent 32bbc36 commit 377ff9d

33 files changed

+89
-85
lines changed

Doc/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,9 @@
256256
('c:data', 'PyExc_UnicodeWarning'),
257257
('c:data', 'PyExc_UserWarning'),
258258
('c:data', 'PyExc_Warning'),
259+
# Undocumented public C macros
260+
('c:macro', 'Py_BUILD_ASSERT'),
261+
('c:macro', 'Py_BUILD_ASSERT_EXPR'),
259262
# Do not error nit-picky mode builds when _SubParsersAction.add_parser cannot
260263
# be resolved, as the method is currently undocumented. For context, see
261264
# https://github.com/python/cpython/pull/103289.

Doc/library/profile.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -692,7 +692,7 @@ you are using :class:`profile.Profile` or :class:`cProfile.Profile`,
692692
As the :class:`cProfile.Profile` class cannot be calibrated, custom timer
693693
functions should be used with care and should be as fast as possible. For
694694
the best results with a custom timer, it might be necessary to hard-code it
695-
in the C source of the internal :mod:`_lsprof` module.
695+
in the C source of the internal :mod:`!_lsprof` module.
696696

697697
Python 3.3 adds several new functions in :mod:`time` that can be used to make
698698
precise measurements of process or wall-clock time. For example, see

Doc/tools/check-warnings.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
from typing import TextIO
1515

1616
# Fail if NEWS nit found before this line number
17-
NEWS_NIT_THRESHOLD = 200
17+
NEWS_NIT_THRESHOLD = 300
1818

1919
# Exclude these whether they're dirty or clean,
2020
# because they trigger a rebuild of dirty files.

Doc/whatsnew/3.4.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1495,7 +1495,7 @@ The dictionary returned by :meth:`.SSLSocket.getpeercert` contains additional
14951495
stat
14961496
----
14971497

1498-
The :mod:`stat` module is now backed by a C implementation in :mod:`_stat`. A C
1498+
The :mod:`stat` module is now backed by a C implementation in :mod:`!_stat`. A C
14991499
implementation is required as most of the values aren't standardized and
15001500
are platform-dependent. (Contributed by Christian Heimes in :issue:`11016`.)
15011501

Doc/whatsnew/3.5.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1935,8 +1935,8 @@ specifying the namespace in which the code will be running.
19351935
tkinter
19361936
-------
19371937

1938-
The :mod:`tkinter._fix` module used for setting up the Tcl/Tk environment
1939-
on Windows has been replaced by a private function in the :mod:`_tkinter`
1938+
The :mod:`!tkinter._fix` module used for setting up the Tcl/Tk environment
1939+
on Windows has been replaced by a private function in the :mod:`!_tkinter`
19401940
module which makes no permanent changes to environment variables.
19411941
(Contributed by Zachary Ware in :issue:`20035`.)
19421942

Doc/whatsnew/3.7.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2048,7 +2048,7 @@ The :mod:`macpath` is now deprecated and will be removed in Python 3.8.
20482048
threading
20492049
---------
20502050

2051-
:mod:`dummy_threading` and :mod:`_dummy_thread` have been deprecated. It is
2051+
:mod:`!dummy_threading` and :mod:`!_dummy_thread` have been deprecated. It is
20522052
no longer possible to build Python with threading disabled.
20532053
Use :mod:`threading` instead.
20542054
(Contributed by Antoine Pitrou in :issue:`31370`.)
@@ -2184,7 +2184,7 @@ The following features and APIs have been removed from Python 3.7:
21842184
``socket.socketpair`` on Python 3.5 and newer.
21852185

21862186
* :mod:`asyncio` no longer exports the :mod:`selectors` and
2187-
:mod:`_overlapped` modules as ``asyncio.selectors`` and
2187+
:mod:`!_overlapped` modules as ``asyncio.selectors`` and
21882188
``asyncio._overlapped``. Replace ``from asyncio import selectors`` with
21892189
``import selectors``.
21902190

Misc/HISTORY

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3952,7 +3952,7 @@ Library
39523952
- Issue #18626: the inspect module now offers a basic command line
39533953
introspection interface (Initial patch by Claudiu Popa)
39543954

3955-
- Issue #3015: Fixed tkinter with wantobject=False. Any Tcl command call
3955+
- Issue #3015: Fixed tkinter with ``wantobjects=False``. Any Tcl command call
39563956
returned empty string.
39573957

39583958
- Issue #19037: The mailbox module now makes all changes to maildir files

Misc/NEWS.d/3.10.0a1.rst

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ convention. Patch by Donghee Na.
9797
.. nonce: aJS9B3
9898
.. section: Core and Builtins
9999
100-
Port the :mod:`_bisect` module to the multi-phase initialization API
100+
Port the :mod:`!_bisect` module to the multi-phase initialization API
101101
(:pep:`489`).
102102

103103
..
@@ -128,7 +128,7 @@ Taskaya.
128128
.. nonce: lh335O
129129
.. section: Core and Builtins
130130
131-
Port the :mod:`_lsprof` extension module to multi-phase initialization
131+
Port the :mod:`!_lsprof` extension module to multi-phase initialization
132132
(:pep:`489`).
133133

134134
..
@@ -148,7 +148,7 @@ Port the :mod:`cmath` extension module to multi-phase initialization
148148
.. nonce: jiXmyT
149149
.. section: Core and Builtins
150150
151-
Port the :mod:`_scproxy` extension module to multi-phase initialization
151+
Port the :mod:`!_scproxy` extension module to multi-phase initialization
152152
(:pep:`489`).
153153

154154
..
@@ -168,7 +168,7 @@ Port the :mod:`termios` extension module to multi-phase initialization
168168
.. nonce: QuDIut
169169
.. section: Core and Builtins
170170
171-
Convert the :mod:`_sha256` extension module types to heap types.
171+
Convert the :mod:`!_sha256` extension module types to heap types.
172172

173173
..
174174
@@ -187,7 +187,7 @@ classes with a huge amount of arguments. Patch by Pablo Galindo.
187187
.. nonce: CnRME3
188188
.. section: Core and Builtins
189189
190-
Port the :mod:`_overlapped` extension module to multi-phase initialization
190+
Port the :mod:`!_overlapped` extension module to multi-phase initialization
191191
(:pep:`489`).
192192

193193
..
@@ -197,7 +197,7 @@ Port the :mod:`_overlapped` extension module to multi-phase initialization
197197
.. nonce: X9CZgo
198198
.. section: Core and Builtins
199199
200-
Port the :mod:`_curses_panel` extension module to multi-phase initialization
200+
Port the :mod:`!_curses_panel` extension module to multi-phase initialization
201201
(:pep:`489`).
202202

203203
..
@@ -207,7 +207,7 @@ Port the :mod:`_curses_panel` extension module to multi-phase initialization
207207
.. nonce: 5jZymK
208208
.. section: Core and Builtins
209209
210-
Port the :mod:`_opcode` extension module to multi-phase initialization
210+
Port the :mod:`!_opcode` extension module to multi-phase initialization
211211
(:pep:`489`).
212212

213213
..
@@ -282,7 +282,7 @@ initialized ``_ast`` module.
282282
.. nonce: vcxSUa
283283
.. section: Core and Builtins
284284
285-
Convert :mod:`_operator` to use :c:func:`PyType_FromSpec`.
285+
Convert :mod:`!_operator` to use :c:func:`PyType_FromSpec`.
286286

287287
..
288288
@@ -291,7 +291,7 @@ Convert :mod:`_operator` to use :c:func:`PyType_FromSpec`.
291291
.. nonce: fubBkb
292292
.. section: Core and Builtins
293293
294-
Port :mod:`_sha3` to multi-phase init. Convert static types to heap types.
294+
Port :mod:`!_sha3` to multi-phase init. Convert static types to heap types.
295295

296296
..
297297
@@ -300,7 +300,7 @@ Port :mod:`_sha3` to multi-phase init. Convert static types to heap types.
300300
.. nonce: FC13e7
301301
.. section: Core and Builtins
302302
303-
Port the :mod:`_blake2` extension module to the multi-phase initialization
303+
Port the :mod:`!_blake2` extension module to the multi-phase initialization
304304
API (:pep:`489`).
305305

306306
..
@@ -339,7 +339,7 @@ The output of ``python --help`` contains now only ASCII characters.
339339
.. nonce: O0d3ym
340340
.. section: Core and Builtins
341341
342-
Port the :mod:`_sha1`, :mod:`_sha512`, and :mod:`_md5` extension modules to
342+
Port the :mod:`!_sha1`, :mod:`!_sha512`, and :mod:`!_md5` extension modules to
343343
multi-phase initialization API (:pep:`489`).
344344

345345
..
@@ -636,7 +636,7 @@ Remove the remaining files from the old parser and the :mod:`symbol` module.
636636
.. nonce: _yI-ax
637637
.. section: Core and Builtins
638638
639-
Convert :mod:`_bz2` to use :c:func:`PyType_FromSpec`.
639+
Convert :mod:`!_bz2` to use :c:func:`PyType_FromSpec`.
640640

641641
..
642642
@@ -666,7 +666,7 @@ by Brandt Bucher.
666666
.. nonce: 61iyYh
667667
.. section: Core and Builtins
668668
669-
Port :mod:`_gdbm` to multiphase initialization.
669+
Port :mod:`!_gdbm` to multiphase initialization.
670670

671671
..
672672
@@ -696,7 +696,7 @@ for emitting syntax errors. Patch by Pablo Galindo.
696696
.. nonce: mmlp3Q
697697
.. section: Core and Builtins
698698
699-
Port :mod:`_dbm` to multiphase initialization.
699+
Port :mod:`!_dbm` to multiphase initialization.
700700

701701
..
702702
@@ -1010,7 +1010,7 @@ Port :mod:`mmap` to multiphase initialization.
10101010
.. nonce: Kfe9fT
10111011
.. section: Core and Builtins
10121012
1013-
Port :mod:`_lzma` to multiphase initialization.
1013+
Port :mod:`!_lzma` to multiphase initialization.
10141014

10151015
..
10161016

Misc/NEWS.d/3.10.0a2.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,7 @@ plistlib: fix parsing XML plists with hexadecimal integer values
362362
.. nonce: 85BsRA
363363
.. section: Library
364364
365-
Fix an incorrectly formatted error from :meth:`_codecs.charmap_decode` when
365+
Fix an incorrectly formatted error from :meth:`!_codecs.charmap_decode` when
366366
called with a mapped value outside the range of valid Unicode code points.
367367
PR by Max Bernstein.
368368

Misc/NEWS.d/3.10.0a3.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1386,7 +1386,7 @@ Python already implicitly installs signal handlers: see
13861386
13871387
The ``Py_TRASHCAN_BEGIN`` macro no longer accesses PyTypeObject attributes,
13881388
but now can get the condition by calling the new private
1389-
:c:func:`_PyTrash_cond()` function which hides implementation details.
1389+
:c:func:`!_PyTrash_cond()` function which hides implementation details.
13901390

13911391
..
13921392

0 commit comments

Comments
 (0)