From 4705e747b8380ce466d81b132134bd4ed399eb45 Mon Sep 17 00:00:00 2001 From: Jelle Zijlstra Date: Tue, 29 Aug 2023 18:25:34 -0700 Subject: [PATCH] Improve documentation (#278) - Move OrderedDict into pure aliases as we dropped support for 3.7 - Explicitly state there is no BC before a final release. Hopefully this is obvious, but just in case we get people complaining about this. --- doc/index.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/index.rst b/doc/index.rst index 7e68e270..ea7ff549 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -56,6 +56,9 @@ be added. Bugfix releases, with version numbers of the form 4.N.1 or higher, may be made if bugs are discovered after a feature release. +We provide no backward compatibility guarantees for prereleases (e.g., +release candidates) and for unreleased code in our Git repository. + Before version 4.0.0, the versioning scheme loosely followed the Python version from which features were backported; for example, ``typing_extensions`` 3.10.0.0 was meant to reflect ``typing`` as of @@ -438,13 +441,6 @@ Special typing primitives Backport ``repr()`` changes from Python 3.12. -Generic concrete collections -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. class:: OrderedDict - - See :py:class:`typing.OrderedDict`. In ``typing`` since 3.7.2. - Abstract Base Classes ~~~~~~~~~~~~~~~~~~~~~ @@ -929,6 +925,10 @@ versions of Python. They are listed here for completeness. .. versionadded:: 4.7.0 +.. class:: OrderedDict + + See :py:class:`typing.OrderedDict`. In ``typing`` since 3.7.2. + .. class:: Pattern See :py:class:`typing.Pattern`.