Complement cheatsheet for Optionals #6074
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
ilevkivskyi
reviewed
Dec 18, 2018
Member
ilevkivskyi
left a comment
ilevkivskyi
left a comment
There was a problem hiding this comment.
Thanks for a PR! I have one comment.
docs/source/cheat_sheet.rst
Outdated
| # First way: with an if condition | ||
| if x is not None: | ||
| print(x.upper()) | ||
| # Second way: with an assert statement |
Member
There was a problem hiding this comment.
These are not just two ways. They are semantically different. The cheat sheet should say something like:
# If it still may be None sometimes, use an if-statement
...
# If it can never be None (e.g. due to some invariants), use an assert
...
Add a paragrah to explain how to indicate to the type checker that an Optional value is not None: with an if statement, or an assert (depending upon the situation)
vincent-prz
force-pushed
the
document-assertions-for-optionals
branch
from
8ae71c7 to
ca95897
Compare
Contributor
Author
|
@ilevkivskyi I have addressed your comment. Does this look good to you ? Thanks! |
ilevkivskyi
approved these changes
Dec 22, 2018
Member
|
Thanks! |
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.
Fixes #5037
Add a paragrah to explain there are 2 ways to make the typechecker
understand that an optional is not
None: use a if condition or anassert.