Crossreferences to standard library in mypy docs #7652
Merged
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
hoefling
commented
Oct 7, 2019
hoefling
commented
Oct 7, 2019
hoefling
commented
Oct 7, 2019
hoefling
commented
Oct 7, 2019
hoefling
commented
Oct 7, 2019
Signed-off-by: Oleg Höfling <[email protected]>
Signed-off-by: Oleg Höfling <[email protected]>
Signed-off-by: Oleg Höfling <[email protected]>
Signed-off-by: Oleg Höfling <[email protected]>
Signed-off-by: Oleg Höfling <[email protected]>
hoefling
force-pushed
the
stdlib-crossref-1
branch
from
4588851 to
a79852e
Compare
gvanrossum
reviewed
Oct 8, 2019
docs/source/additional_features.rst
Outdated
| have imprecise (too permissive) types. This will be fixed in future releases. | ||
|
|
||
| Mypy does not yet recognize aliases of ``dataclasses.dataclass``, and will | ||
| Mypy does not yet recognize aliases of :py:func:`dataclasses.dataclass`, and will |
There was a problem hiding this comment.
This one causes is a regression in rendering IMO. The :py:func: version gets rendered with a trailing () pair, while the original gets rendered without it. Since an alias to a function does not involve calling it, IMO it should be rendered without (). (Maybe one of the other :py: things link the same way but render without ()?)
There was a problem hiding this comment.
Dang, missed that. Sure, the proper ref here would be
:py:func:`dataclasses.dataclass <dataclasses.dataclass>`
Will fix that!
…in command_line.rst Signed-off-by: Oleg Höfling <[email protected]>
gvanrossum
approved these changes
Oct 8, 2019
|
The tilde removes the dotted path in the rendered text. E.g. will render as will render as just |
JukkaL
pushed a commit
that referenced
this pull request
Jul 31, 2020
This adds crossrefs to the docs, a follow-up of #7652 (crossrefs to standard library items) and #7784 (crossrefs for command line options), only now for the config file values. Signed-off-by: Oleg Höfling <[email protected]>
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 following documents:
additional_features.rstcasts.rstclass_basics.rstcommand_line.rstThis is part of splitting up the changes in #7624 into more readable PRs.