Skip to content

Commit

Permalink
gh-101100: Fix sphinx warnings in Doc/library/__future__.rst (#109814)
Browse files Browse the repository at this point in the history
  • Loading branch information
sobolevn authored Sep 25, 2023
1 parent 7b8bfe1 commit f2eaa92
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 27 deletions.
58 changes: 32 additions & 26 deletions Doc/library/__future__.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,42 +22,48 @@
can be inspected programmatically via importing :mod:`__future__` and examining
its contents.

Each statement in :file:`__future__.py` is of the form::
.. _future-classes:

FeatureName = _Feature(OptionalRelease, MandatoryRelease,
CompilerFlag)
.. class:: _Feature

Each statement in :file:`__future__.py` is of the form::

where, normally, *OptionalRelease* is less than *MandatoryRelease*, and both are
5-tuples of the same form as :data:`sys.version_info`::
FeatureName = _Feature(OptionalRelease, MandatoryRelease,
CompilerFlag)

(PY_MAJOR_VERSION, # the 2 in 2.1.0a3; an int
PY_MINOR_VERSION, # the 1; an int
PY_MICRO_VERSION, # the 0; an int
PY_RELEASE_LEVEL, # "alpha", "beta", "candidate" or "final"; string
PY_RELEASE_SERIAL # the 3; an int
)
where, normally, *OptionalRelease* is less than *MandatoryRelease*, and both are
5-tuples of the same form as :data:`sys.version_info`::

*OptionalRelease* records the first release in which the feature was accepted.
(PY_MAJOR_VERSION, # the 2 in 2.1.0a3; an int
PY_MINOR_VERSION, # the 1; an int
PY_MICRO_VERSION, # the 0; an int
PY_RELEASE_LEVEL, # "alpha", "beta", "candidate" or "final"; string
PY_RELEASE_SERIAL # the 3; an int
)

In the case of a *MandatoryRelease* that has not yet occurred,
*MandatoryRelease* predicts the release in which the feature will become part of
the language.
.. method:: _Feature.getOptionalRelease()

Else *MandatoryRelease* records when the feature became part of the language; in
releases at or after that, modules no longer need a future statement to use the
feature in question, but may continue to use such imports.
*OptionalRelease* records the first release in which the feature was accepted.

*MandatoryRelease* may also be ``None``, meaning that a planned feature got
dropped.
.. method:: _Feature.getMandatoryRelease()

Instances of class :class:`_Feature` have two corresponding methods,
:meth:`getOptionalRelease` and :meth:`getMandatoryRelease`.
In the case of a *MandatoryRelease* that has not yet occurred,
*MandatoryRelease* predicts the release in which the feature will become part of
the language.

*CompilerFlag* is the (bitfield) flag that should be passed in the fourth
argument to the built-in function :func:`compile` to enable the feature in
dynamically compiled code. This flag is stored in the :attr:`compiler_flag`
attribute on :class:`_Feature` instances.
Else *MandatoryRelease* records when the feature became part of the language; in
releases at or after that, modules no longer need a future statement to use the
feature in question, but may continue to use such imports.

*MandatoryRelease* may also be ``None``, meaning that a planned feature got
dropped or that it is not yet decided.

.. attribute:: _Feature.compiler_flag

*CompilerFlag* is the (bitfield) flag that should be passed in the fourth
argument to the built-in function :func:`compile` to enable the feature in
dynamically compiled code. This flag is stored in the :attr:`_Feature.compiler_flag`
attribute on :class:`_Feature` instances.

No feature description will ever be deleted from :mod:`__future__`. Since its
introduction in Python 2.1 the following features have found their way into the
Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ Doc/howto/enum.rst
Doc/howto/isolating-extensions.rst
Doc/howto/logging.rst
Doc/howto/urllib2.rst
Doc/library/__future__.rst
Doc/library/abc.rst
Doc/library/ast.rst
Doc/library/asyncio-dev.rst
Expand Down

0 comments on commit f2eaa92

Please sign in to comment.