Rollup merge of #76338 - euclio:intra-link-iterator, r=jyn514

add some intra-doc links to `Iterator`
This commit is contained in:
Dylan DPC 2020-09-07 01:18:08 +02:00 committed by GitHub
commit 9f69a232a6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -809,7 +809,7 @@ pub trait Iterator {
Enumerate::new(self) Enumerate::new(self)
} }
/// Creates an iterator which can use `peek` to look at the next element of /// Creates an iterator which can use [`peek`] to look at the next element of
/// the iterator without consuming it. /// the iterator without consuming it.
/// ///
/// Adds a [`peek`] method to an iterator. See its documentation for /// Adds a [`peek`] method to an iterator. See its documentation for
@ -1992,7 +1992,7 @@ pub trait Iterator {
/// The same as [`fold()`], but uses the first element in the /// The same as [`fold()`], but uses the first element in the
/// iterator as the initial value, folding every subsequent element into it. /// iterator as the initial value, folding every subsequent element into it.
/// If the iterator is empty, return `None`; otherwise, return the result /// If the iterator is empty, return [`None`]; otherwise, return the result
/// of the fold. /// of the fold.
/// ///
/// [`fold()`]: Iterator::fold /// [`fold()`]: Iterator::fold
@ -2821,7 +2821,7 @@ pub trait Iterator {
Product::product(self) Product::product(self)
} }
/// Lexicographically compares the elements of this `Iterator` with those /// Lexicographically compares the elements of this [`Iterator`] with those
/// of another. /// of another.
/// ///
/// # Examples /// # Examples
@ -2843,7 +2843,7 @@ pub trait Iterator {
self.cmp_by(other, |x, y| x.cmp(&y)) self.cmp_by(other, |x, y| x.cmp(&y))
} }
/// Lexicographically compares the elements of this `Iterator` with those /// Lexicographically compares the elements of this [`Iterator`] with those
/// of another with respect to the specified comparison function. /// of another with respect to the specified comparison function.
/// ///
/// # Examples /// # Examples
@ -2895,7 +2895,7 @@ pub trait Iterator {
} }
} }
/// Lexicographically compares the elements of this `Iterator` with those /// Lexicographically compares the elements of this [`Iterator`] with those
/// of another. /// of another.
/// ///
/// # Examples /// # Examples
@ -2919,7 +2919,7 @@ pub trait Iterator {
self.partial_cmp_by(other, |x, y| x.partial_cmp(&y)) self.partial_cmp_by(other, |x, y| x.partial_cmp(&y))
} }
/// Lexicographically compares the elements of this `Iterator` with those /// Lexicographically compares the elements of this [`Iterator`] with those
/// of another with respect to the specified comparison function. /// of another with respect to the specified comparison function.
/// ///
/// # Examples /// # Examples
@ -2980,7 +2980,7 @@ pub trait Iterator {
} }
} }
/// Determines if the elements of this `Iterator` are equal to those of /// Determines if the elements of this [`Iterator`] are equal to those of
/// another. /// another.
/// ///
/// # Examples /// # Examples
@ -2999,7 +2999,7 @@ pub trait Iterator {
self.eq_by(other, |x, y| x == y) self.eq_by(other, |x, y| x == y)
} }
/// Determines if the elements of this `Iterator` are equal to those of /// Determines if the elements of this [`Iterator`] are equal to those of
/// another with respect to the specified equality function. /// another with respect to the specified equality function.
/// ///
/// # Examples /// # Examples
@ -3040,7 +3040,7 @@ pub trait Iterator {
} }
} }
/// Determines if the elements of this `Iterator` are unequal to those of /// Determines if the elements of this [`Iterator`] are unequal to those of
/// another. /// another.
/// ///
/// # Examples /// # Examples
@ -3059,7 +3059,7 @@ pub trait Iterator {
!self.eq(other) !self.eq(other)
} }
/// Determines if the elements of this `Iterator` are lexicographically /// Determines if the elements of this [`Iterator`] are lexicographically
/// less than those of another. /// less than those of another.
/// ///
/// # Examples /// # Examples
@ -3080,7 +3080,7 @@ pub trait Iterator {
self.partial_cmp(other) == Some(Ordering::Less) self.partial_cmp(other) == Some(Ordering::Less)
} }
/// Determines if the elements of this `Iterator` are lexicographically /// Determines if the elements of this [`Iterator`] are lexicographically
/// less or equal to those of another. /// less or equal to those of another.
/// ///
/// # Examples /// # Examples
@ -3101,7 +3101,7 @@ pub trait Iterator {
matches!(self.partial_cmp(other), Some(Ordering::Less | Ordering::Equal)) matches!(self.partial_cmp(other), Some(Ordering::Less | Ordering::Equal))
} }
/// Determines if the elements of this `Iterator` are lexicographically /// Determines if the elements of this [`Iterator`] are lexicographically
/// greater than those of another. /// greater than those of another.
/// ///
/// # Examples /// # Examples
@ -3122,7 +3122,7 @@ pub trait Iterator {
self.partial_cmp(other) == Some(Ordering::Greater) self.partial_cmp(other) == Some(Ordering::Greater)
} }
/// Determines if the elements of this `Iterator` are lexicographically /// Determines if the elements of this [`Iterator`] are lexicographically
/// greater than or equal to those of another. /// greater than or equal to those of another.
/// ///
/// # Examples /// # Examples