Use list[int] instead of typing.List[int] in generics.rst #11377
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also change typing.Tuple to tuple, typing.Dict to dict, etc. Using standard containers is the best practice moving forward, so we should encourage it in examples. I just deleted the info about `typing.List` and friends from the "Generic class internals" section, since that shouldn't be needed going forward, and I wanted to try to keep this doc as slim as possible.
|
Also not sure if this is the direction you're looking for, or if this change needs more explicit mention of the difference between |
hauntsaninja
requested changes
Oct 31, 2021
|
Sounds good, thanks @hauntsaninja! I added a comment within the code block to make it even more obvious since I thought the modifier in the paragraph before ("For Python 3.8 and below...") would be way too easy to miss. I stacked a new commit on top so the progression is recorded. The two commits should be squashed when they are actually merged. |
hauntsaninja
reviewed
Nov 2, 2021
|
Thanks! |
NickCrews
added a commit
to NickCrews/mypy
that referenced
this pull request
Nov 3, 2021
As well as `Dict[X, Y]` -> `dic[X, Y]`, etc. This is a follow-up to python#11377, where just a single page of the docs was transitioned. I did a grep through the docs/ directory for anything matching "List[", "Dict[", "Tuple[", and "Set[" and corrected any examples. Perhaps I missed something, but my goal was to clean all of the docs. I tried to strike a balance of how explicit to be: In places related to collections, such as the "Explicit types for collections" section of `type_inference_and_annotations.rst`, I kept in notes about the differences between `List` and `list`. But in most examples that were focused on some other topic, I just deleted any reference to `typing.List`. I thought any notes there would just add noise. There also is a correction to `command_line.rst`, I tested using `--disallow-any-generics` with `list[int]` and it works fine. There are a few typos and style fixes scattered throughout as well when I touched them.
NickCrews
added a commit
to NickCrews/mypy
that referenced
this pull request
Nov 3, 2021
As well as `Dict[X, Y]` -> `dic[X, Y]`, etc. This is a follow-up to python#11377, where just a single page of the docs was transitioned. I did a grep through the docs/ directory for anything matching "List[", "Dict[", "Tuple[", and "Set[" and corrected any examples. Perhaps I missed something, but my goal was to clean all of the docs. I tried to strike a balance of how explicit to be: In places related to collections, such as the "Explicit types for collections" section of `type_inference_and_annotations.rst`, I kept in notes about the differences between `List` and `list`. But in most examples that were focused on some other topic, I just deleted any reference to `typing.List`. I thought any notes there would just add noise. There also is a correction to `command_line.rst`, I tested using `--disallow-any-generics` with `list[int]` and it works fine. There are a few typos and style fixes scattered throughout as well when I touched them.
tushar-deepsource
pushed a commit
to DeepSourceCorp/mypy
that referenced
this pull request
Jan 20, 2022
Also change typing.Tuple to tuple, typing.Dict to dict, etc.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Also change typing.Tuple to tuple, typing.Dict to dict, etc.
Using standard containers is the best practice moving
forward, so we should encourage it in examples.
I just deleted the info about
typing.Listand friends from the"Generic class internals" section, since that shouldn't be needed
going forward, and I wanted to try to keep this doc as slim as possible.
Description
Doesn't change behavior
Test Plan
Haven't tested rebuilding docs, I assume CI will test that if you approve it to run.