Improve documentation for annotating generator functions - #11623
Merged
Conversation
The mypy documentation is currently ambivalent on whether ``Iterator`` or ``Iterable`` is the better return-type annotation for a simple generator function. The documentation should endorse using ``Iterator`` instead of ``Iterable`, in my opinion, as it is a more precise return type, and no less concise.
sobolevn
reviewed
Nov 26, 2021
Member
There was a problem hiding this comment.
Thanks, one question from me 🙂
Related python/cpython#29170
AlexWaygood
marked this pull request as draft
November 26, 2021 11:17
AlexWaygood
marked this pull request as ready for review
November 26, 2021 14:13
Member
Author
|
@sobolevn, thoughts on the PR now? 🙂 |
Collaborator
|
Thank you! |
Member
Author
Thanks for the reviews! |
tushar-deepsource
pushed a commit
to DeepSourceCorp/mypy
that referenced
this pull request
Jan 20, 2022
The mypy documentation is currently ambivalent on whether ``Iterator`` or ``Iterable`` is the better return-type annotation for a simple generator function. The documentation should endorse using ``Iterator`` instead of ``Iterable`, in my opinion, as it is a more precise return type, and no less concise.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
The mypy documentation is currently ambivalent on whether
IteratororIterableis the better return-type annotation for a simple generator function. The documentation should endorse usingIteratorinstead ofIterable, in my opinion, as it is a more precise return type, and no less concise.