doc: Method examples for Result and Option #17339
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
Remove ~~~ for code block specification. Use /// Over /** */ for doc blocks.
| @@ -270,6 +326,18 @@ impl<T> Option<T> { | |||
| /// In general, because this function may fail, its use is discouraged. | |||
| /// Instead, prefer to use pattern matching and handle the `None` | |||
| /// case explicitly. | |||
| /// | |||
| /// # Examle | |||
|
Thanks for this! one other comment: do we need the leading |
|
We do not actually need the |
|
Currently, I've been using Do you want to maybe collaborate on some kind of doc style guide RFC? /cc @aturon |
|
I could collaborate on something like that yeah. |
|
r? |
bors
added a commit
that referenced
this pull request
Sep 22, 2014
Also some cleanup to conform to documentation style.
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.
Also some cleanup to conform to documentation style.