Skip to content

Crossreferences to standard library in mypy docs, part 6#7697

Merged
gvanrossum merged 2 commits into
python:masterfrom
hoefling:stdlib-crossref-6
Oct 12, 2019
Merged

Crossreferences to standard library in mypy docs, part 6#7697
gvanrossum merged 2 commits into
python:masterfrom
hoefling:stdlib-crossref-6

Conversation

@hoefling

Copy link
Copy Markdown
Contributor

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.

Signed-off-by: Oleg Höfling <oleg.hoefling@gmail.com>
Comment thread docs/source/more_types.rst Outdated
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

@hoefling hoefling Oct 11, 2019

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think an additional link to the event loop doc here will be helpful..?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a single link is sufficient here. The asyncio event loop docs are not directly relevant here anyway.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree, removed!

* :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)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please advise whether referencing dict methods is useful here.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think it is useful.

Signed-off-by: Oleg Höfling <oleg.hoefling@gmail.com>
* :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)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think it is useful.

@gvanrossum gvanrossum merged commit de7ba2b into python:master Oct 12, 2019
@hoefling hoefling deleted the stdlib-crossref-6 branch October 13, 2019 07:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants