docs(option): fixes for several docstrings #68
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
zth
approved these changes
Feb 24, 2023
cknitt
reviewed
Feb 24, 2023
| @@ -96,8 +96,7 @@ Option.getUnsafe(None) // Raises an error | |||
| external getUnsafe: option<'a> => 'a = "%identity" | |||
|
|
|||
| /** | |||
| `mapWithDefault(opt, default, f)` applies `f` to `opt`, if `opt` is `None`, then | |||
| `f` return `default`, otherwise return that value applied with `f`. | |||
| `mapWithDefault(opt, default, f)` returns `Some(f(value))` if `opt` is `Some(value)`, otherwise `default`. | |||
There was a problem hiding this comment.
Shouldn't this be "... returns f(value)"?
There was a problem hiding this comment.
Ah, yeah it should be. Good catch! Fixed in #70
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.
I found the existing docstrings confusing, so I propose some simplifying changes.