Skip to content

Commit bbfd0cc

Browse files
Extend docs intro (#168)
1 parent 88be907 commit bbfd0cc

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

doc/index.rst

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,33 @@ repository. If the PEP is accepted, the feature will then be added to the
1919
affected ``typing_extensions`` has been rejected so far, so we haven't yet
2020
figured out how to deal with that possibility.
2121

22+
Bugfixes and new typing features that don't require a PEP may be added to
23+
``typing_extensions`` once they are merged into CPython's main branch.
24+
25+
Versioning and backwards compatibility
26+
--------------------------------------
27+
2228
Starting with version 4.0.0, ``typing_extensions`` uses
23-
`Semantic Versioning <https://semver.org>`_. The
24-
major version is incremented for all backwards-incompatible changes.
29+
`Semantic Versioning <https://semver.org>`_. A changelog is
30+
maintained `on GitHub <https://github.com/python/typing_extensions/blob/main/CHANGELOG.md>`_.
31+
32+
The major version is incremented for all backwards-incompatible changes.
2533
Therefore, it's safe to depend
2634
on ``typing_extensions`` like this: ``typing_extensions >=x.y, <(x+1)``,
2735
where ``x.y`` is the first version that includes all features you need.
2836
In view of the wide usage of ``typing_extensions`` across the ecosystem,
2937
we are highly hesitant to break backwards compatibility, and we do not
3038
expect to increase the major version number in the foreseeable future.
3139

32-
``typing_extensions`` supports Python versions 3.7 and higher. In the future,
40+
Before version 4.0.0, the versioning scheme loosely followed the Python
41+
version from which features were backported; for example,
42+
``typing_extensions`` 3.10.0.0 was meant to reflect ``typing`` as of
43+
Python 3.10.0. During this period, no changelog was maintained.
44+
45+
Python version support
46+
----------------------
47+
48+
``typing_extensions`` currently supports Python versions 3.7 and higher. In the future,
3349
support for older Python versions will be dropped some time after that version
3450
reaches end of life.
3551

0 commit comments

Comments
 (0)