Skip to content

Commit

Permalink
pythongh-101100: Fix Sphinx warnings in whatsnew/3.11.rst and relat…
Browse files Browse the repository at this point in the history 
…ed (python#114531)
  • Loading branch information
@hugovk
hugovk committed Jan 27, 2024
1 parent 11c5822 commit b6623d6
Show file tree
Hide file tree
Showing 15 changed files with 70 additions and 70 deletions.
2 changes: 1 addition & 1 deletion Doc/whatsnew/2.7.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2130,7 +2130,7 @@ Changes to Python's build process and to the C API include:
only the filename, function name, and first line number are required.
This is useful for extension modules that are attempting to
construct a more useful traceback stack. Previously such
extensions needed to call :c:func:`PyCode_New`, which had many
extensions needed to call :c:func:`!PyCode_New`, which had many
more arguments. (Added by Jeffrey Yasskin.)

* New function: :c:func:`PyErr_NewExceptionWithDoc` creates a new
Expand Down
96 changes: 48 additions & 48 deletions Doc/whatsnew/3.11.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -672,7 +672,7 @@ enum

* Changed :meth:`Enum.__format__() <enum.Enum.__format__>` (the default for
:func:`format`, :meth:`str.format` and :term:`f-string`\s) to always produce
the same result as :meth:`Enum.__str__()`: for enums inheriting from
the same result as :meth:`Enum.__str__() <enum.Enum.__str__>`: for enums inheriting from
:class:`~enum.ReprEnum` it will be the member's value; for all other enums
it will be the enum and member name (e.g. ``Color.RED``).

Expand Down Expand Up @@ -1604,7 +1604,7 @@ raw, adaptive bytecode containing quickened data.
New opcodes
-----------

* :opcode:`ASYNC_GEN_WRAP`, :opcode:`RETURN_GENERATOR` and :opcode:`SEND`,
* :opcode:`!ASYNC_GEN_WRAP`, :opcode:`RETURN_GENERATOR` and :opcode:`SEND`,
used in generators and co-routines.

* :opcode:`COPY_FREE_VARS`,
Expand All @@ -1615,7 +1615,7 @@ New opcodes

* :opcode:`MAKE_CELL`, to create :ref:`cell-objects`.

* :opcode:`CHECK_EG_MATCH` and :opcode:`PREP_RERAISE_STAR`,
* :opcode:`CHECK_EG_MATCH` and :opcode:`!PREP_RERAISE_STAR`,
to handle the :ref:`new exception groups and except* <whatsnew311-pep654>`
added in :pep:`654`.

Expand All @@ -1630,38 +1630,38 @@ New opcodes
Replaced opcodes
----------------

+------------------------------------+-----------------------------------+-----------------------------------------+
| Replaced Opcode(s) | New Opcode(s) | Notes |
+====================================+===================================+=========================================+
| | :opcode:`!BINARY_*` | :opcode:`BINARY_OP` | Replaced all numeric binary/in-place |
| | :opcode:`!INPLACE_*` | | opcodes with a single opcode |
+------------------------------------+-----------------------------------+-----------------------------------------+
| | :opcode:`!CALL_FUNCTION` | | :opcode:`CALL` | Decouples argument shifting for methods |
| | :opcode:`!CALL_FUNCTION_KW` | | :opcode:`KW_NAMES` | from handling of keyword arguments; |
| | :opcode:`!CALL_METHOD` | | :opcode:`PRECALL` | allows better specialization of calls |
| | | :opcode:`PUSH_NULL` | |
+------------------------------------+-----------------------------------+-----------------------------------------+
| | :opcode:`!DUP_TOP` | | :opcode:`COPY` | Stack manipulation instructions |
| | :opcode:`!DUP_TOP_TWO` | | :opcode:`SWAP` | |
| | :opcode:`!ROT_TWO` | | |
| | :opcode:`!ROT_THREE` | | |
| | :opcode:`!ROT_FOUR` | | |
| | :opcode:`!ROT_N` | | |
+------------------------------------+-----------------------------------+-----------------------------------------+
| | :opcode:`!JUMP_IF_NOT_EXC_MATCH` | | :opcode:`CHECK_EXC_MATCH` | Now performs check but doesn't jump |
+------------------------------------+-----------------------------------+-----------------------------------------+
| | :opcode:`!JUMP_ABSOLUTE` | | :opcode:`JUMP_BACKWARD` | See [#bytecode-jump]_; |
| | :opcode:`!POP_JUMP_IF_FALSE` | | :opcode:`POP_JUMP_BACKWARD_IF_* | ``TRUE``, ``FALSE``, |
| | :opcode:`!POP_JUMP_IF_TRUE` | <POP_JUMP_BACKWARD_IF_TRUE>` | ``NONE`` and ``NOT_NONE`` variants |
| | | :opcode:`POP_JUMP_FORWARD_IF_* | for each direction |
| | <POP_JUMP_FORWARD_IF_TRUE>` | |
+------------------------------------+-----------------------------------+-----------------------------------------+
| | :opcode:`!SETUP_WITH` | :opcode:`BEFORE_WITH` | :keyword:`with` block setup |
| | :opcode:`!SETUP_ASYNC_WITH` | | |
+------------------------------------+-----------------------------------+-----------------------------------------+
+------------------------------------+------------------------------------+-----------------------------------------+
| Replaced Opcode(s) | New Opcode(s) | Notes |
+====================================+====================================+=========================================+
| | :opcode:`!BINARY_*` | :opcode:`BINARY_OP` | Replaced all numeric binary/in-place |
| | :opcode:`!INPLACE_*` | | opcodes with a single opcode |
+------------------------------------+------------------------------------+-----------------------------------------+
| | :opcode:`!CALL_FUNCTION` | | :opcode:`CALL` | Decouples argument shifting for methods |
| | :opcode:`!CALL_FUNCTION_KW` | | :opcode:`!KW_NAMES` | from handling of keyword arguments; |
| | :opcode:`!CALL_METHOD` | | :opcode:`!PRECALL` | allows better specialization of calls |
| | | :opcode:`PUSH_NULL` | |
+------------------------------------+------------------------------------+-----------------------------------------+
| | :opcode:`!DUP_TOP` | | :opcode:`COPY` | Stack manipulation instructions |
| | :opcode:`!DUP_TOP_TWO` | | :opcode:`SWAP` | |
| | :opcode:`!ROT_TWO` | | |
| | :opcode:`!ROT_THREE` | | |
| | :opcode:`!ROT_FOUR` | | |
| | :opcode:`!ROT_N` | | |
+------------------------------------+------------------------------------+-----------------------------------------+
| | :opcode:`!JUMP_IF_NOT_EXC_MATCH` | | :opcode:`CHECK_EXC_MATCH` | Now performs check but doesn't jump |
+------------------------------------+------------------------------------+-----------------------------------------+
| | :opcode:`!JUMP_ABSOLUTE` | | :opcode:`JUMP_BACKWARD` | See [#bytecode-jump]_; |
| | :opcode:`!POP_JUMP_IF_FALSE` | | :opcode:`!POP_JUMP_BACKWARD_IF_*`| ``TRUE``, ``FALSE``, |
| | :opcode:`!POP_JUMP_IF_TRUE` | | :opcode:`!POP_JUMP_FORWARD_IF_*` | ``NONE`` and ``NOT_NONE`` variants |
| | | for each direction |
| | | |
+------------------------------------+------------------------------------+-----------------------------------------+
| | :opcode:`!SETUP_WITH` | :opcode:`BEFORE_WITH` | :keyword:`with` block setup |
| | :opcode:`!SETUP_ASYNC_WITH` | | |
+------------------------------------+------------------------------------+-----------------------------------------+

.. [#bytecode-jump] All jump opcodes are now relative, including the
existing :opcode:`JUMP_IF_TRUE_OR_POP` and :opcode:`JUMP_IF_FALSE_OR_POP`.
existing :opcode:`!JUMP_IF_TRUE_OR_POP` and :opcode:`!JUMP_IF_FALSE_OR_POP`.
The argument is now an offset from the current instruction
rather than an absolute location.
Expand Down Expand Up @@ -1789,21 +1789,21 @@ Standard Library
and will be removed in a future Python version,
due to not supporting resources located within package subdirectories:

* :func:`importlib.resources.contents`
* :func:`importlib.resources.is_resource`
* :func:`importlib.resources.open_binary`
* :func:`importlib.resources.open_text`
* :func:`importlib.resources.read_binary`
* :func:`importlib.resources.read_text`
* :func:`importlib.resources.path`
* :func:`!importlib.resources.contents`
* :func:`!importlib.resources.is_resource`
* :func:`!importlib.resources.open_binary`
* :func:`!importlib.resources.open_text`
* :func:`!importlib.resources.read_binary`
* :func:`!importlib.resources.read_text`
* :func:`!importlib.resources.path`

* The :func:`locale.getdefaultlocale` function is deprecated and will be
removed in Python 3.15. Use :func:`locale.setlocale`,
:func:`locale.getpreferredencoding(False) <locale.getpreferredencoding>` and
:func:`locale.getlocale` functions instead.
(Contributed by Victor Stinner in :gh:`90817`.)

* The :func:`locale.resetlocale` function is deprecated and will be
* The :func:`!locale.resetlocale` function is deprecated and will be
removed in Python 3.13. Use ``locale.setlocale(locale.LC_ALL, "")`` instead.
(Contributed by Victor Stinner in :gh:`90817`.)

Expand Down Expand Up @@ -1967,7 +1967,7 @@ Removed C APIs are :ref:`listed separately <whatsnew311-c-api-removed>`.

(Contributed by Victor Stinner in :issue:`45085`.)

* Removed the :mod:`distutils` ``bdist_msi`` command deprecated in Python 3.9.
* Removed the :mod:`!distutils` ``bdist_msi`` command deprecated in Python 3.9.
Use ``bdist_wheel`` (wheel packages) instead.
(Contributed by Hugo van Kemenade in :issue:`45124`.)

Expand Down Expand Up @@ -2295,7 +2295,7 @@ Porting to Python 3.11
as its second parameter, instead of ``PyFrameObject*``.
See :pep:`523` for more details of how to use this function pointer type.

* :c:func:`PyCode_New` and :c:func:`PyCode_NewWithPosOnlyArgs` now take
* :c:func:`!PyCode_New` and :c:func:`!PyCode_NewWithPosOnlyArgs` now take
an additional ``exception_table`` argument.
Using these functions should be avoided, if at all possible.
To get a custom code object: create a code object using the compiler,
Expand Down Expand Up @@ -2402,7 +2402,7 @@ Porting to Python 3.11
been included directly, consider including ``Python.h`` instead.
(Contributed by Victor Stinner in :issue:`35134`.)

* The :c:func:`PyUnicode_CHECK_INTERNED` macro has been excluded from the
* The :c:func:`!PyUnicode_CHECK_INTERNED` macro has been excluded from the
limited C API. It was never usable there, because it used internal structures
which are not available in the limited C API.
(Contributed by Victor Stinner in :issue:`46007`.)
Expand Down Expand Up @@ -2465,7 +2465,7 @@ Porting to Python 3.11

Debuggers that accessed the :attr:`~frame.f_locals` directly *must* call
:c:func:`PyFrame_GetLocals` instead. They no longer need to call
:c:func:`PyFrame_FastToLocalsWithError` or :c:func:`PyFrame_LocalsToFast`,
:c:func:`!PyFrame_FastToLocalsWithError` or :c:func:`!PyFrame_LocalsToFast`,
in fact they should not call those functions. The necessary updating of the
frame is now managed by the virtual machine.

Expand Down Expand Up @@ -2604,8 +2604,8 @@ and will be removed in Python 3.12.
* :c:func:`!PyUnicode_GET_DATA_SIZE`
* :c:func:`!PyUnicode_GET_SIZE`
* :c:func:`!PyUnicode_GetSize`
* :c:func:`PyUnicode_IS_COMPACT`
* :c:func:`PyUnicode_IS_READY`
* :c:func:`!PyUnicode_IS_COMPACT`
* :c:func:`!PyUnicode_IS_READY`
* :c:func:`PyUnicode_READY`
* :c:func:`!PyUnicode_WSTR_LENGTH`
* :c:func:`!_PyUnicode_AsUnicode`
Expand Down Expand Up @@ -2660,7 +2660,7 @@ Removed
(Contributed by Victor Stinner in :issue:`45474`.)

* Exclude :c:func:`PyWeakref_GET_OBJECT` from the limited C API. It never
worked since the :c:type:`PyWeakReference` structure is opaque in the
worked since the :c:type:`!PyWeakReference` structure is opaque in the
limited C API.
(Contributed by Victor Stinner in :issue:`35134`.)

Expand Down
4 changes: 2 additions & 2 deletions Doc/whatsnew/3.8.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1623,8 +1623,8 @@ Build and C API Changes
allocation or deallocation may need to be adjusted.
(Contributed by Eddie Elizondo in :issue:`35810`.)

* The new function :c:func:`PyCode_NewWithPosOnlyArgs` allows to create
code objects like :c:func:`PyCode_New`, but with an extra *posonlyargcount*
* The new function :c:func:`!PyCode_NewWithPosOnlyArgs` allows to create
code objects like :c:func:`!PyCode_New`, but with an extra *posonlyargcount*
parameter for indicating the number of positional-only arguments.
(Contributed by Pablo Galindo in :issue:`37221`.)

Expand Down
2 changes: 1 addition & 1 deletion Misc/NEWS.d/3.11.0a2.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1189,7 +1189,7 @@ context objects can now be disabled.
.. section: C API
Exclude :c:func:`PyWeakref_GET_OBJECT` from the limited C API. It never
worked since the :c:type:`PyWeakReference` structure is opaque in the
worked since the :c:type:`!PyWeakReference` structure is opaque in the
limited C API.

..
Expand Down
6 changes: 3 additions & 3 deletions Misc/NEWS.d/3.11.0a4.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ faster due to reference-counting optimizations. Patch by Dennis Sweeney.
.. nonce: 7oGp-I
.. section: Core and Builtins
:opcode:`PREP_RERAISE_STAR` no longer pushes ``lasti`` to the stack.
:opcode:`!PREP_RERAISE_STAR` no longer pushes ``lasti`` to the stack.

..
Expand All @@ -170,7 +170,7 @@ faster due to reference-counting optimizations. Patch by Dennis Sweeney.
.. nonce: IKx4v6
.. section: Core and Builtins
Remove :opcode:`POP_EXCEPT_AND_RERAISE` and replace it by an equivalent
Remove :opcode:`!POP_EXCEPT_AND_RERAISE` and replace it by an equivalent
sequence of other opcodes.

..
Expand Down Expand Up @@ -1171,7 +1171,7 @@ Replaced deprecated usage of :c:func:`PyImport_ImportModuleNoBlock` with
.. nonce: sMgDLz
.. section: C API
The :c:func:`PyUnicode_CHECK_INTERNED` macro has been excluded from the
The :c:func:`!PyUnicode_CHECK_INTERNED` macro has been excluded from the
limited C API. It was never usable there, because it used internal
structures which are not available in the limited C API. Patch by Victor
Stinner.
2 changes: 1 addition & 1 deletion Misc/NEWS.d/3.11.0a6.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ Don't un-adapt :opcode:`COMPARE_OP` when collecting specialization stats.
.. nonce: RX_AzJ
.. section: Core and Builtins
Fix specialization stats gathering for :opcode:`PRECALL` instructions.
Fix specialization stats gathering for :opcode:`!PRECALL` instructions.

..
Expand Down
4 changes: 2 additions & 2 deletions Misc/NEWS.d/3.11.0a7.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ Replaced :opcode:`JUMP_ABSOLUTE` by the relative jump
.. nonce: SwrrFO
.. section: Core and Builtins
:c:func:`PyFrame_FastToLocalsWithError` and :c:func:`PyFrame_LocalsToFast`
:c:func:`!PyFrame_FastToLocalsWithError` and :c:func:`!PyFrame_LocalsToFast`
are no longer called during profiling nor tracing. C code can access the
``f_locals`` attribute of :c:type:`PyFrameObject` by calling
:c:func:`PyFrame_GetLocals`.
Expand Down Expand Up @@ -295,7 +295,7 @@ oparg) as an adaptive counter.
.. nonce: O12Pba
.. section: Core and Builtins
Use inline caching for :opcode:`PRECALL` and :opcode:`CALL`, and remove the
Use inline caching for :opcode:`!PRECALL` and :opcode:`CALL`, and remove the
internal machinery for managing the (now unused) non-inline caches.

..
Expand Down
4 changes: 2 additions & 2 deletions Misc/NEWS.d/3.11.0b1.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -403,8 +403,8 @@ so this led to crashes. The problem is now fixed.
.. nonce: 6S_uoU
.. section: Core and Builtins
Make opcodes :opcode:`JUMP_IF_TRUE_OR_POP` and
:opcode:`JUMP_IF_FALSE_OR_POP` relative rather than absolute.
Make opcodes :opcode:`!JUMP_IF_TRUE_OR_POP` and
:opcode:`!JUMP_IF_FALSE_OR_POP` relative rather than absolute.

..
Expand Down
4 changes: 2 additions & 2 deletions Misc/NEWS.d/3.12.0a4.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ Fix misleading default value in :func:`input`'s ``__text_signature__``.
.. nonce: cmGwxv
.. section: Core and Builtins
Remove :opcode:`UNARY_POSITIVE`, :opcode:`ASYNC_GEN_WRAP` and
:opcode:`LIST_TO_TUPLE`, replacing them with intrinsics.
Remove :opcode:`!UNARY_POSITIVE`, :opcode:`!ASYNC_GEN_WRAP` and
:opcode:`!LIST_TO_TUPLE`, replacing them with intrinsics.

..
Expand Down
2 changes: 1 addition & 1 deletion Misc/NEWS.d/3.12.0a6.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ all as not all platform C libraries generate an error.
.. section: Core and Builtins
Add :opcode:`CALL_INTRINSIC_2` and use it instead of
:opcode:`PREP_RERAISE_STAR`.
:opcode:`!PREP_RERAISE_STAR`.

..
Expand Down
2 changes: 1 addition & 1 deletion Misc/NEWS.d/3.12.0a7.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Reduce the number of inline :opcode:`CACHE` entries for
.. nonce: PRkGca
.. section: Core and Builtins
Removed :opcode:`JUMP_IF_FALSE_OR_POP` and :opcode:`JUMP_IF_TRUE_OR_POP`
Removed :opcode:`!JUMP_IF_FALSE_OR_POP` and :opcode:`!JUMP_IF_TRUE_OR_POP`
instructions.

..
Expand Down
2 changes: 1 addition & 1 deletion Misc/NEWS.d/3.12.0b1.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1008,7 +1008,7 @@ Update the bundled copy of pip to version 23.1.2.
.. nonce: pst8iT
.. section: Library
Make :mod:`dis` display the value of oparg of :opcode:`KW_NAMES`.
Make :mod:`dis` display the value of oparg of :opcode:`!KW_NAMES`.

..
Expand Down
4 changes: 2 additions & 2 deletions Misc/NEWS.d/3.8.0a1.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3395,8 +3395,8 @@ Zackery Spytz.
.. nonce: S0Irst
.. section: Library
Fix parsing non-ASCII identifiers in :mod:`lib2to3.pgen2.tokenize` (PEP
3131).
Fix parsing non-ASCII identifiers in :mod:`!lib2to3.pgen2.tokenize`
(:pep:`3131`).

..
Expand Down
4 changes: 2 additions & 2 deletions Misc/NEWS.d/3.9.0a1.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5715,8 +5715,8 @@ The :c:macro:`METH_FASTCALL` calling convention has been documented.
.. nonce: 4tClQT
.. section: C API
The new function :c:func:`PyCode_NewWithPosOnlyArgs` allows to create code
objects like :c:func:`PyCode_New`, but with an extra *posonlyargcount*
The new function :c:func:`!PyCode_NewWithPosOnlyArgs` allows to create code
objects like :c:func:`!PyCode_New`, but with an extra *posonlyargcount*
parameter for indicating the number of positonal-only arguments.

..
Expand Down
2 changes: 1 addition & 1 deletion Misc/NEWS.d/3.9.0a5.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1122,7 +1122,7 @@ a different condition than the GIL.
.. nonce: Nbl7lF
.. section: Tools/Demos
Added support to fix ``getproxies`` in the :mod:`lib2to3.fixes.fix_urllib`
Added support to fix ``getproxies`` in the :mod:`!lib2to3.fixes.fix_urllib`
module. Patch by José Roberto Meza Cabrera.

..
Expand Down

0 comments on commit b6623d6

Please sign in to comment.