Various docs improvements #16836
Merged
Various docs improvements #16836
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
Recommend `--disable-error-code=import-untyped`. It's probably strictly better than `--ignore-missing-imports` for most users. Remove the displaying error codes section, since it's on by default. Some more advice and discoverability for "using mypy with an existing codebase".
| You can also set the :option:`--ignore-missing-imports <mypy --ignore-missing-imports>` | ||
| command line flag or set the :confval:`ignore_missing_imports` config file | ||
| option to True in the *global* section of your mypy config file. We | ||
| recommend avoiding ``--ignore-missing-imports`` if possible: it's equivalent |
There was a problem hiding this comment.
Isn't that also what disable_error_code = import-untyped does? Might need a clearer explanation of the difference.
There was a problem hiding this comment.
No, if you have a typo, your error code will be import-not-found instead of import-untyped. I link to the import-untyped docs that explain this
Co-authored-by: Jelle Zijlstra <[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.
Recommend
--disable-error-code=import-untyped. It's probably strictly better than--ignore-missing-importsfor most users.Remove the displaying error codes section, since it's on by default.
Some more advice and discoverability for "using mypy with an existing codebase".