Crossreferences to standard library in mypy docs, part 6 #7697
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
Signed-off-by: Oleg Höfling <[email protected]>
hoefling
commented
Oct 11, 2019
docs/source/more_types.rst
Outdated
| decorator to convert a generator into a coroutine. | ||
|
|
||
| Note that we set the ``YieldType`` of the generator to be ``Any`` in the | ||
| following example. This is because the exact yield type is an implementation | ||
| detail of the coroutine runner (e.g. the ``asyncio`` event loop) and your | ||
| detail of the coroutine runner (e.g. the :py:mod:`asyncio` :doc:`event loop <library/asyncio-eventloop>`) and your |
There was a problem hiding this comment.
I think an additional link to the event loop doc here will be helpful..?
There was a problem hiding this comment.
I think a single link is sufficient here. The asyncio event loop docs are not directly relevant here anyway.
| * :py:meth:`d.setdefault(key, default) <dict.setdefault>` | ||
| * :py:meth:`d1.update(d2) <dict.update>` | ||
| * :py:meth:`d.pop(key[, default]) <dict.pop>` (partial ``TypedDict``\s only) | ||
| * ``del d[key]`` (partial ``TypedDict``\s only) |
There was a problem hiding this comment.
Please advise whether referencing dict methods is useful here.
Signed-off-by: Oleg Höfling <[email protected]>
gvanrossum
approved these changes
Oct 12, 2019
| * :py:meth:`d.setdefault(key, default) <dict.setdefault>` | ||
| * :py:meth:`d1.update(d2) <dict.update>` | ||
| * :py:meth:`d.pop(key[, default]) <dict.pop>` (partial ``TypedDict``\s only) | ||
| * ``del d[key]`` (partial ``TypedDict``\s only) |
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.
Added references to the
more_types.rst. This is the second-to-last part of splitting up the changes in #7624 into more readable PRs.