Skip to content
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

Jump to bottom

Docs: Update TypedDict import statements #16958

Merged
merged 4 commits into from
Feb 29, 2024
Merged

Docs: Update TypedDict import statements #16958

merged 4 commits into from
Feb 29, 2024

Commits on Feb 28, 2024

  1. Docs: Update TypedDict import statements 

    Since Python 3.8, `TypedDict` has been available from the `typing` module. 

As Python 3.8+ is needed to use mypy (https://github.com/python/mypy/blob/master/setup.py#L12), then it's best for the docs to reflect Python 3.8+ usage.

For previous versions, there's already a disclaimer on the page that explains that `typing_extensions` must be used: https://github.com/python/mypy/blob/master/docs/source/typed_dict.rst?plain=1#L102-L110
    @rdimaio
    rdimaio authored Feb 28, 2024
    Configuration menu
    Copy the full SHA
    6fe6a78 View commit details
    Browse the repository at this point in the history

Commits on Feb 29, 2024

  1. Docs: Python 3.8, Update typing_extensions imports to typing

    @rdimaio
    rdimaio committed Feb 29, 2024
    Configuration menu
    Copy the full SHA
    8453b10 View commit details
    Browse the repository at this point in the history

  2. Docs: revert from typing to typing_extensions when needed

    @rdimaio
    rdimaio committed Feb 29, 2024
    Configuration menu
    Copy the full SHA
    d4366a9 View commit details
    Browse the repository at this point in the history

  3. Update docs/source/typed_dict.rst 

    Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
    @rdimaio @AlexWaygood
    rdimaio and AlexWaygood authored Feb 29, 2024
    Configuration menu
    Copy the full SHA
    fe40bcd View commit details
    Browse the repository at this point in the history