We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
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
yield
Describe the bug When writing generators, the yield type includes the Iterator type.
Iterator
To Reproduce Example file:
from typing import Iterator def a_generator() -> Iterator[int]: """Generate a number. Yields: A number. """ yield 1
Expected behavior The yield type should be the inner type, for example for Iterator[int] it should be int.
Iterator[int]
int
Screenshots In this case the yielded type is actually int, not Iterator[int].
System (please complete the following information):
mkdocstrings-python
The text was updated successfully, but these errors were encountered:
fix: Extract actual type for yielded/received values
3ea37ba
Issue mkdocstrings/python#75: mkdocstrings/python#75
Hello, thanks for the report. I agree 🙂 We should do the same for Receives. I just pushed a fix and will try to release soon.
Sorry, something went wrong.
Great, thanks!
No branches or pull requests
Describe the bug
When writing generators, the yield type includes the
Iterator
type.To Reproduce
Example file:
Expected behavior
The yield type should be the inner type, for example for
Iterator[int]
it should beint
.Screenshots
In this case the
yield
ed type is actuallyint
, notIterator[int]
.System (please complete the following information):
mkdocstrings-python
version: 1.1.2The text was updated successfully, but these errors were encountered: