str: fix comments for FromStr for bool #22959
Closed
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
|
r? @pcwalton (rust_highfive has picked a reviewer for you, use r? to override) |
Fix the return type in the comments. An old commit 082bfde ("Fallout of std::str stabilization") removed the example of FromStr::from_str(), this commit adds it back. But the example of StrExt::parse() is still kept with an additinal note. Signed-off-by: Lai Jiangshan <[email protected]>
| /// | ||
| /// # Examples | ||
| /// | ||
| /// ```rust | ||
| /// assert_eq!(from_str::<bool>("true"), OK(true)); | ||
| /// assert_eq!(from_str::<bool>("false"), OK(false)); |
There was a problem hiding this comment.
I think these instances of OK should be Ok instead. Also, I believe you can leave off the type annotations due to the usage of true and false to derive inference (but not in the error example below).
You can be sure to run these doc-blocks via make check-stage2-doc-crate-core
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.
Fix the return type in the comments.
An old commit 082bfde ("Fallout of std::str stabilization") removed
the example of FromStr::from_str(), this commit adds it back. But
the example of StrExt::parse() is still kept with an additinal note.
Signed-off-by: Lai Jiangshan [email protected]