KEMBAR78
Stubgen command line options reference anchors by hoefling · Pull Request #7801 · python/mypy · GitHub
Skip to content

Conversation

hoefling
Copy link
Contributor

This is the follow-up of #7784. Added :option: directives in stubgen.rst.

Note: since there are two programs listing options (mypy and stubgen), a proper reference should be

:option:`program-name --option-name`

for example

:option:`mypy --py2`

(since stubgen also offers this option, so the reference to the option alone would be ambiguous otherwise).

Of course, custom text is supported, as with all roles:

:option:`--py2 <mypy --py2>`

the program name can be thus omitted in link text.

…in stubgen.rst

Signed-off-by: Oleg Höfling <oleg.hoefling@gmail.com>
Copy link
Collaborator

@JukkaL JukkaL left a comment

Choose a reason for hiding this comment

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

Excellent, thanks!

@JukkaL JukkaL merged commit 9e18cd2 into python:master Oct 28, 2019
@hoefling hoefling deleted the stubgen-options-refs branch November 2, 2019 23:24
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.

2 participants