Clarify the purpose of getOrElse #104
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
Member
|
Thanks for the PR @emma-burrows. Sorry I didn't respond earlier I was a bit busy. |
FRosner
reviewed
Jun 7, 2018
src/main/scala/stdlib/Options.scala
Outdated
| * }}} | ||
| * | ||
| * Using `getOrElse` we can provide a default value ("No value") when the optional argument (`None`) does not exist: | ||
| * Using `getOrElse`, we can extract the value if the `Option[A]` is a `Some[A]`, and provide a default value ("No value") when the optional argument (`None`) does not exist: |
Member
There was a problem hiding this comment.
I think the whole sentence is a bit clumsy.
Maybe we can rewrite it to something like this:
Using
getOrElse, we can extract the value if it exists, or return a provided default value. If we have aSome(x)we can returnx, and forNonewe return the default value.
What do you think?
Contributor
Author
There was a problem hiding this comment.
Yes, I think in general, more numerous, shorter sentences are best. I'll update the PR as suggested.
FRosner
approved these changes
Jun 7, 2018
Member
|
Thanks a lot! I'm gonna wait until tomorrow if someone else has any feedback. Otherwise I'll merge it :) |
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.
Just a little tweak to make it clearer to beginners that
getOrElsewill return the wrapped value if theOptionis aSome, and the provided default value if it isNone(since there seemed to be some confusion in the comments on this section).