Adjust language as per suggestions

This commit is contained in:
varkor 2018-01-19 21:16:34 +00:00
parent 91668fbf23
commit 0be51730ee
2 changed files with 11 additions and 9 deletions

View file

@ -25,10 +25,6 @@ fn _assert_is_object_safe(_: &Iterator<Item=()>) {}
/// generally, please see the [module-level documentation]. In particular, you
/// may want to know how to [implement `Iterator`][impl].
///
/// Note: Methods on infinite iterators that generally require traversing every
/// element to produce a result may not terminate, even on traits for which a
/// result is determinable in finite time.
///
/// [module-level documentation]: index.html
/// [impl]: index.html#implementing-iterator
#[stable(feature = "rust1", since = "1.0.0")]
@ -1430,6 +1426,10 @@ pub trait Iterator {
/// Folding is useful whenever you have a collection of something, and want
/// to produce a single value from it.
///
/// Note: `fold()`, and similar methods that traverse the entire iterator,
/// may not terminate for infinite iterators, even on traits for which a
/// result is determinable in finite time.
///
/// # Examples
///
/// Basic usage:

View file

@ -299,15 +299,17 @@
//! This will print the numbers `0` through `4`, each on their own line.
//!
//! Bear in mind that methods on infinite iterators, even those for which a
//! result can be computed in finite time, may not terminate. Specifically,
//! methods such as [`min`], which in the general case require traversing
//! every element in the iterator, are likely never to terminate for any
//! infinite iterators.
//! result can be determined mathematically in finite time, may not terminate.
//! Specifically, methods such as [`min`], which in the general case require
//! traversing every element in the iterator, are likely not to return
//! successfully for any infinite iterators.
//!
//! ```no_run
//! let positives = 1..;
//! let least = positives.min().unwrap(); // Oh no! An infinite loop!
//! // `positives.min` causes an infinite loop, so we won't reach this point!
//! // `positives.min` will either overflow and panic (in debug mode),
//! // or cause an infinite loop (in release mode), so we won't reach
//! // this point!
//! println!("The least positive number is {}.", least);
//! ```
//!