Skip to content

bpo-46494: Mention the typing_extensions pkg in typing docs #31260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 8, 2022
Merged

bpo-46494: Mention the typing_extensions pkg in typing docs #31260

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a763bc8
Mention the typing_extensions pkg in typing docs
meersuri Feb 10, 2022
d6bded3
Clarify the description of typing_extensions
meersuri Feb 11, 2022
155f1ac
Make the python version part more explicit
meersuri Feb 19, 2022
278c177
Update wording
meersuri Mar 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@ In the function ``greeting``, the argument ``name`` is expected to be of type
:class:`str` and the return type :class:`str`. Subtypes are accepted as
arguments.

New features have been added to the typing module in each major version of
Copy link
Member

Choose a reason for hiding this comment

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

have been -> are?

(not a native speaker)

Copy link
Member

Choose a reason for hiding this comment

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

I think "have been" is right. "are" would imply that we keep adding new features to each version, which has been true so far but isn't something we can promise will remain true :)

But separately, I think "major version" is wrong. Python 3 is a major version, but here we're talking about 3.9, 3.10, etc. Those are minor versions.

Suggested change
New features have been added to the typing module in each major version of
New features have been added to the typing module in each version of

Python. The `typing_extensions <https://pypi.org/project/typing-extensions/>`_
package provides backports to all supported versions of Python 3 for almost
Copy link
Member

@sobolevn sobolevn Feb 10, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

There are couple of questions I have after reading this sentence:

  • What are "all supported versions"?
  • Why "almost all features"? Which ones are not backported? Why?

Maybe we can rephrase it like so?

The typing_extensions package provides backports of new ``typing`` features to older versions of Python.

Copy link
Member

Choose a reason for hiding this comment

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

I think your rephrasing is good since it avoids these problems. "All supported versions" is supposed to mean all Python 3 versions that are still supported, and "almost all features" is because there's some things that can't be backported (e.g., PEP 604, PEP 585).

all of these features.

.. _relevant-peps:

Relevant PEPs
Expand Down