Skip to content

[Docs] add a new Sphinx VersionChange directive .. scheduled-changed:: #131733

Closed as not planned
@XuehaiPan

Description

@XuehaiPan

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:

def setup(app: Sphinx) -> ExtensionMetadata:
# Override Sphinx's directives with support for 'next'
app.add_directive("versionadded", PyVersionChange, override=True)
app.add_directive("versionchanged", PyVersionChange, override=True)
app.add_directive("versionremoved", PyVersionChange, override=True)
app.add_directive("deprecated", PyVersionChange, override=True)
# Register the ``.. deprecated-removed::`` directive
app.add_directive("deprecated-removed", DeprecatedRemoved)

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dirpendingThe issue will be closed if no feedback is providedtype-featureA feature request or enhancement

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions