Recategorize and document --warn-incomplete-stub
#5555
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
Previously, the `--warn-incomplete-stub` flag was inconsistently
documented: it was missing from the "Mypy command line" section of
the docs, but was documented in the "Mypy configuration file" section
and appeared under "Untyped definitions and calls" section when
running `mypy --help`.
This pull request:
1. Adds documentation for this flag to the command line docs.
2. Recategorizes the flag to fall under "Mypy internals" -- I
can't really see people other then typeshed contributors
finding this flag useful.
3. Updates the docs so it states this flag is useful only when
using `--disallow-incomplete-defs` or `--disallow-untyped-defs`
instead of `--check-untyped-defs`. This option appears to be
used [only once in checker.py][0] -- the `check_untyped_defs`
option does not seem relevant there.
[0]: https://github.com/python/mypy/blob/master/mypy/checker.py#L947
Michael0x2a
force-pushed
the
adjust-warn-incomplete-stub-docs
branch
from
9fa99ed to
9ddffa7
Compare
gvanrossum
approved these changes
Sep 2, 2018
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.
Previously, the
--warn-incomplete-stubflag was inconsistently documented: it was missing from the "Mypy command line" section of the docs, but was documented in the "Mypy configuration file" section and appeared under "Untyped definitions and calls" section when runningmypy --help.This pull request:
Adds documentation for this flag to the command line docs.
Recategorizes the flag to fall under "Mypy internals" -- I can't really see people other then typeshed contributors finding this flag useful.
Updates the docs so it states this flag is useful only when using
--disallow-incomplete-defsor--disallow-untyped-defsinstead of--check-untyped-defs. This option appears to be used only once in checker.py -- thecheck_untyped_defsoption does not seem relevant there.