Add dedicated docstrings to Sum/Product impl of Result #42570
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
|
(rust_highfive has picked a reviewer for you, use r? to override) |
|
r? @frewsxcv -- documentation PR |
Mark-Simulacrum
added
the
S-waiting-on-review
frewsxcv
suggested changes
Jun 11, 2017
src/libcore/iter/traits.rs
Outdated
| /// elements are taken, and the `Err` is returned. Should no `Err` occur, | ||
| /// the sum of all elements is returned. | ||
| /// | ||
| /// Here is an example which sums up every integer in a vector, |
There was a problem hiding this comment.
As per rust-lang/rfcs#1574, there should be an # Examples line before this line
src/libcore/iter/traits.rs
Outdated
| /// if x < 0 { Err("Negative element found") } | ||
| /// else { Ok(x) } | ||
| /// ).sum(); | ||
| /// assert!(res == Ok(3)); |
| /// let v = vec![1, 2]; | ||
| /// let res: Result<i32, &'static str> = v.iter().map(|&x: &i32| | ||
| /// if x < 0 { Err("Negative element found") } | ||
| /// else { Ok(x) } |
There was a problem hiding this comment.
Your change from https://github.com/rust-lang/rust/pull/42569/files could be copied here
There was a problem hiding this comment.
Hm, it's not so easy to apply here. Suggestion?
(and fix a minor grammar typo below)
|
@bors r+ rollup Thanks! |
|
📌 Commit 2366c46 has been approved by |
bors
added a commit
that referenced
this pull request
Jun 12, 2017
Add dedicated docstrings to Sum/Product impl of Result (and fix a minor grammar typo below)
|
☀️ Test successful - status-appveyor, status-travis |
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.
(and fix a minor grammar typo below)