docs: Improve documentation for Result #14
Merged
Conversation
This file contains 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
Contributor
skarllot
commented
Jun 22, 2024
skarllot
commented
- Categorize operators documentation for Result
- Add missing documentation for Result operators
jeffijoe
reviewed
Jun 22, 2024
docs/core/result.md
Outdated
| int resultValue = result.Unwrap("Optional error message"); | ||
| ``` | ||
|
|
||
| Or you can use `UnwrapOr` / `UnwrapOrElse` and specify a fallback value for when result is in error state. |
There was a problem hiding this comment.
Suggested change
| Or you can use `UnwrapOr` / `UnwrapOrElse` and specify a fallback value for when result is in error state. | |
| Or you can use `UnwrapOr` / `UnwrapOrElse` and specify a fallback value for when the result is in the error state. |
docs/core/result.md
Outdated
|
|
||
| ### UnwrapEither | ||
|
|
||
| The `UnwrapEither` returns either the value or the error when `Result` value type is the same of error type. |
There was a problem hiding this comment.
Suggested change
| The `UnwrapEither` returns either the value or the error when `Result` value type is the same of error type. | |
| The `UnwrapEither` method returns either the Ok value or the Err value when both are of the same type. |
docs/core/result.md
Outdated
|
|
||
| ### UnwrapErr | ||
|
|
||
| The `UnwrapErr` gets the `Err` value, or throws an exception otherwise. |
There was a problem hiding this comment.
Suggested change
| The `UnwrapErr` gets the `Err` value, or throws an exception otherwise. | |
| The `UnwrapErr` method gets the `Err` value, or throws an exception otherwise. |
docs/core/result.md
Outdated
| @@ -27,6 +31,197 @@ else | |||
| } | |||
| ``` | |||
|
|
|||
| ### Unwrap | |||
|
|
|||
| The `Unwrap` / `UnwrapOrThrow` gets the `Ok` value, or throws an exception otherwise. | |||
There was a problem hiding this comment.
Suggested change
| The `Unwrap` / `UnwrapOrThrow` gets the `Ok` value, or throws an exception otherwise. | |
| The `Unwrap` / `UnwrapOrThrow` methods get the `Ok` value, or throw an exception otherwise. |
jeffijoe
approved these changes
Jun 23, 2024
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.