Skip to content

Update rustdoc for iterator.rs #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion library/core/src/iter/traits/iterator.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3493,7 +3493,9 @@ pub trait Iterator {
///
/// Takes each element, adds them together, and returns the result.
///
/// An empty iterator returns the zero value of the type.
/// An empty iterator returns the zero value of the type except in the event
/// of summing primitive types that have negative zero values like f32 and f64.
/// An empty iterator of these types will return the negative zero value.
///
/// `sum()` can be used to sum any type implementing [`Sum`][`core::iter::Sum`],
/// including [`Option`][`Option::sum`] and [`Result`][`Result::sum`].
Expand All @@ -3511,6 +3513,10 @@ pub trait Iterator {
/// let sum: i32 = a.iter().sum();
///
/// assert_eq!(sum, 6);
///
/// let b: Vec<f32> = vec![];
/// let sum: f32 = b.iter().sum();
/// assert_eq!(sum, -0.0_f32);
/// ```
#[stable(feature = "iter_arith", since = "1.11.0")]
fn sum<S>(self) -> S
Expand Down
Loading