Adds better type narrowing docs #11088
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
docs/source/type_narrowing.rst
Outdated
|
|
||
| .. note:: | ||
|
|
||
| Narrowing type for some impossible state will be treated as an error. |
There was a problem hiding this comment.
This isn't generally true, e.g. not even with --strict, I think you need --warn-unreachable for this.
There was a problem hiding this comment.
Could also maybe mention the assert_never trick here though
There was a problem hiding this comment.
This is awesome. I made a bunch of small wording changes. The only substantive comment here is about --warn-unreachable which we need to be a little careful about. E.g., there's some discussion of it here: https://mypy.readthedocs.io/en/stable/common_issues.html#unreachable-code
|
@hauntsaninja thanks a lot for your help! I've added a note about |
|
Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
List of changed:
castsintotype-narrowingTypeGuardtype there, it fits perfectlyRefs #11014
CC @hauntsaninja