Skip to content

docs: add version compatibility table#733

Merged
srittau merged 4 commits into
python:mainfrom
r266-tech:docs/version-table
Jun 11, 2026
Merged

docs: add version compatibility table#733
srittau merged 4 commits into
python:mainfrom
r266-tech:docs/version-table

Conversation

@r266-tech

Copy link
Copy Markdown
Contributor

Summary

Adds a version compatibility table to the documentation, as requested in #299.

The table lists objects provided by typing_extensions that backport or extend features from the standard library, showing:

  • Object name (cross-linked to its docs entry)
  • Python version when the feature was added to typing
  • typing_extensions release that first included it
  • Associated PEP (if any)

This follows the format suggested by @JelleZijlstra in the issue discussion, using a list-table directive as recommended by @AlexWaygood for easier maintenance.

Closes #299

@python-cla-bot

python-cla-bot Bot commented Mar 22, 2026

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

CLA signed

Comment thread doc/index.rst Outdated
* - :class:`Buffer`
- 3.12
- 4.6.0
-

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was PEP 688

Comment thread doc/index.rst Outdated
- 4.15.0
- :pep:`800`
* - :func:`evaluate_forward_ref`
-

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

3.14

@codecov

codecov Bot commented Mar 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.19%. Comparing base (01bd34f) to head (cd0c4cf).

@@           Coverage Diff           @@
##             main     #733   +/-   ##
=======================================
  Coverage   97.19%   97.19%           
=======================================
  Files           3        3           
  Lines        7815     7815           
=======================================
  Hits         7596     7596           
  Misses        219      219           
Flag Coverage Δ
3.10 88.94% <ø> (ø)
3.10.4 88.94% <ø> (ø)
3.11 88.18% <ø> (ø)
3.11.0 87.43% <ø> (ø)
3.12 88.13% <ø> (ø)
3.12.0 88.12% <ø> (ø)
3.13 82.94% <ø> (ø)
3.13.0 83.65% <ø> (ø)
3.14 79.04% <ø> (ø)
3.9 89.64% <ø> (ø)
3.9.12 89.64% <ø> (ø)
pypy3.10 88.77% <ø> (ø)
pypy3.11 88.04% <ø> (ø)
pypy3.9 89.47% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@JelleZijlstra

Copy link
Copy Markdown
Member

I'm happy to finish this up but @r266-tech are you willing to sign the contributor license agreement? Otherwise we'll have to close this PR.

Add a table listing typing_extensions objects that backport or extend
features from the standard library, showing:
- Python version when the feature was added to typing
- typing_extensions release that first included it
- Associated PEP (if any)

Closes python#299
@r266-tech r266-tech force-pushed the docs/version-table branch from 4ddd22e to 7541a36 Compare May 7, 2026 08:17
@r266-tech

Copy link
Copy Markdown
Contributor Author

@JelleZijlstra CLA signed and check is green now — happy to have you finish it up whenever convenient, thanks!

@r266-tech

Copy link
Copy Markdown
Contributor Author

Addressed both review comments in e16f2ba: added PEP 688 for Buffer and 3.14 as the typing version for evaluate_forward_ref. Docs build cleanly locally — should be ready to finish up whenever convenient.

@srittau

srittau commented Jun 11, 2026

Copy link
Copy Markdown
Collaborator

The CI failures are unrelated codecov problems.

@srittau

srittau commented Jun 11, 2026

Copy link
Copy Markdown
Collaborator

Hmm, it seems like we don't have a readthedocs preview, and I'm not sure how the docs are build and deployed to readthedocs.

@r266-tech

Copy link
Copy Markdown
Contributor Author

The current CI failures look unrelated to this docs patch/codecov, as noted above. I do not see a per-PR Read the Docs preview configured for this repo; after e16f2ba I verified the docs locally with Sphinx and the compatibility table renders from doc/index.rst. The branch is otherwise only carrying the two review fixes.

@srittau srittau merged commit d277746 into python:main Jun 11, 2026
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

List of included items by the version in which they were included in Python.

3 participants