Make Some
example in something
docstring more informative
#47682
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.
Previous example:
PR example:
The previous example this PR replaces was a potentially confusing and nonsensical use of
Some
withsomething
.(AFAIU from the docs), The sole purpose of
Some
is to distinguish a non-valuenothing
from a valuenothing
(presumably with the use ofsomething
). Therefore, a literalSome(1)
is not an informative example, since an unwrapped1
would also be returned bysomething
(i.e. theSome
wrapper in that example does not change the result).The new example is a clearer way of showing how
something
andSome
interact.