Mypy command line options reference anchors #7784
Merged
Conversation
This file contains 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
changed the title
|
Another side effect would be fixing (rare) typos in command args, i.e. |
…command_line.rst Signed-off-by: Oleg Höfling <oleg.hoefling@gmail.com>
hoefling
force-pushed
the
options-refs
branch
from
1dea0bf
to
f19034b
Compare
msullivan
approved these changes
Oct 25, 2019
This was referenced Oct 26, 2019
JukkaL
pushed a commit
that referenced
this pull request
Oct 28, 2019
This is the follow-up of #7784. All options verbatim texts and :ref: usages are replaced with the :option: role.
JukkaL
pushed a commit
that referenced
this pull request
Jul 31, 2020
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.
Also added references in
command_line.rst. This is another suggestion for adding crossrefs to the docs. If you like this suggestion, I will add more PRs that replace verbatim option texts with references in chunks (same approach as with the stdlib crossrefs).Motivation
When reading the docs in the other PR I made earlier, I noticed the command line options are referenced throughout the docs. For that, a label is added above the command line paragraph which is linked by using the
refrole. Although this does generate a valid link, e.g. in Import discovery:this doesn't look nice (the verbatim formatting is missing and the double hyphens are merged to an em dash) and the overall construct (adding an anchor and using
reffor referencing) can be simplified by using the:option:directive. When rendered, it will add an anchor automatically:The anchor can then be referenced by using the
:option:role: