Repository navigation
[Docs] add a new Sphinx VersionChange directive .. scheduled-changed:: #131733
Description
Documentation
Follow the discussion in #127405 (comment):
No reason to actually use the word "deprecation" except to explain what process we're following for changing a user-visible and documented API.
The change is added in PR #131717:
.. versionchanged:: 3.14
A deprecation warning will be emitted if the :data:`sys.abiflags` member
is accessed on Windows.
The :data:`sys.abiflags` member will be set to a meaningful value on
Windows in Python 3.16. This means the :data:`sys.abiflags` member will
always be available on all platforms starting from Python 3.16.A .. versionchanged:: directive is not very accurate for this change. It would be nice to have a new directive .. scheduled-changed:::
.. scheduled-changed:: 3.14 3.16
A deprecation warning will be emitted if the :data:`sys.abiflags` member
is accessed on Windows.
The :data:`sys.abiflags` member will be set to a meaningful value on
Windows in Python 3.16. This means the :data:`sys.abiflags` member will
always be available on all platforms starting from Python 3.16.Like the .. deprecated-removed:: directive:
cpython/Doc/tools/extensions/changes.py
Lines 76 to 84 in 8ada7a9
Activity
AA-Turner commentedon Mar 25, 2025
I'm not sure I see the benefit, I would probably use a caution directive paired with a versionchanged for 3.14.
A
picnixz commentedon Mar 28, 2025
I also think a
cautionwould be better than a new directive (well, it could help in distinguishing these two when reading the rst but the online docs wouldn't see a difference IMO)