Skip to content

Commit 9933ea1

Browse files
committed
Add method links in docs of free functions
1 parent 08036af commit 9933ea1

File tree

5 files changed

+16
-16
lines changed

5 files changed

+16
-16
lines changed

src/adaptors/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -481,7 +481,7 @@ pub type Merge<I, J> = MergeBy<I, J, MergeLte>;
481481

482482
/// Create an iterator that merges elements in `i` and `j`.
483483
///
484-
/// [`IntoIterator`] enabled version of `i.merge(j)`.
484+
/// [`IntoIterator`] enabled version of [`Itertools::merge`](crate::Itertools::merge).
485485
///
486486
/// ```
487487
/// use itertools::merge;

src/concat_impl.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ use crate::Itertools;
22

33
/// Combine all an iterator's elements into one element by using [`Extend`].
44
///
5-
/// [`IntoIterator`]-enabled version of `.concat()`
5+
/// [`IntoIterator`]-enabled version of [`Itertools::concat`].
66
///
77
/// This combinator will extend the first item with each of the rest of the
88
/// items of the iterator. If the iterator is empty, the default value of

src/free.rs

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ pub use crate::rciter_impl::rciter;
3737

3838
/// Iterate `iterable` with a running index.
3939
///
40-
/// [`IntoIterator`] enabled version of `.enumerate()`.
40+
/// [`IntoIterator`] enabled version of [`Iterator::enumerate`].
4141
///
4242
/// ```
4343
/// use itertools::enumerate;
@@ -54,7 +54,7 @@ pub fn enumerate<I>(iterable: I) -> iter::Enumerate<I::IntoIter>
5454

5555
/// Iterate `iterable` in reverse.
5656
///
57-
/// [`IntoIterator`] enabled version of `.rev()`.
57+
/// [`IntoIterator`] enabled version of [`Iterator::rev`].
5858
///
5959
/// ```
6060
/// use itertools::rev;
@@ -72,7 +72,7 @@ pub fn rev<I>(iterable: I) -> iter::Rev<I::IntoIter>
7272

7373
/// Iterate `i` and `j` in lock step.
7474
///
75-
/// [`IntoIterator`] enabled version of `i.zip(j)`.
75+
/// [`IntoIterator`] enabled version of [`Iterator::zip`].
7676
///
7777
/// ```
7878
/// use itertools::zip;
@@ -91,7 +91,7 @@ pub fn zip<I, J>(i: I, j: J) -> Zip<I::IntoIter, J::IntoIter>
9191

9292
/// Create an iterator that first iterates `i` and then `j`.
9393
///
94-
/// `IntoIterator` enabled version of `i.chain(j)`.
94+
/// [`IntoIterator`] enabled version of [`Iterator::chain`].
9595
///
9696
/// ```
9797
/// use itertools::chain;
@@ -109,7 +109,7 @@ pub fn chain<I, J>(i: I, j: J) -> iter::Chain<<I as IntoIterator>::IntoIter, <J
109109

110110
/// Create an iterator that clones each element from &T to T
111111
///
112-
/// [`IntoIterator`] enabled version of `i.cloned()`.
112+
/// [`IntoIterator`] enabled version of [`Iterator::cloned`].
113113
///
114114
/// ```
115115
/// use itertools::cloned;
@@ -125,7 +125,7 @@ pub fn cloned<'a, I, T: 'a>(iterable: I) -> iter::Cloned<I::IntoIter>
125125

126126
/// Perform a fold operation over the iterable.
127127
///
128-
/// [`IntoIterator`] enabled version of `i.fold(init, f)`
128+
/// [`IntoIterator`] enabled version of [`Iterator::fold`].
129129
///
130130
/// ```
131131
/// use itertools::fold;
@@ -141,7 +141,7 @@ pub fn fold<I, B, F>(iterable: I, init: B, f: F) -> B
141141

142142
/// Test whether the predicate holds for all elements in the iterable.
143143
///
144-
/// [`IntoIterator`] enabled version of `i.all(f)`
144+
/// [`IntoIterator`] enabled version of [`Iterator::all`].
145145
///
146146
/// ```
147147
/// use itertools::all;
@@ -157,7 +157,7 @@ pub fn all<I, F>(iterable: I, f: F) -> bool
157157

158158
/// Test whether the predicate holds for any elements in the iterable.
159159
///
160-
/// [`IntoIterator`] enabled version of `i.any(f)`
160+
/// [`IntoIterator`] enabled version of [`Iterator::any`].
161161
///
162162
/// ```
163163
/// use itertools::any;
@@ -173,7 +173,7 @@ pub fn any<I, F>(iterable: I, f: F) -> bool
173173

174174
/// Return the maximum value of the iterable.
175175
///
176-
/// [`IntoIterator`] enabled version of `i.max()`.
176+
/// [`IntoIterator`] enabled version of [`Iterator::max`].
177177
///
178178
/// ```
179179
/// use itertools::max;
@@ -189,7 +189,7 @@ pub fn max<I>(iterable: I) -> Option<I::Item>
189189

190190
/// Return the minimum value of the iterable.
191191
///
192-
/// [`IntoIterator`] enabled version of `i.min()`.
192+
/// [`IntoIterator`] enabled version of [`Iterator::min`].
193193
///
194194
/// ```
195195
/// use itertools::min;
@@ -206,7 +206,7 @@ pub fn min<I>(iterable: I) -> Option<I::Item>
206206

207207
/// Combine all iterator elements into one String, seperated by `sep`.
208208
///
209-
/// [`IntoIterator`] enabled version of `iterable.join(sep)`.
209+
/// [`IntoIterator`] enabled version of [`Itertools::join`].
210210
///
211211
/// ```
212212
/// use itertools::join;

src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3371,7 +3371,7 @@ impl<T: ?Sized> Itertools for T where T: Iterator { }
33713371
/// `false` otherwise.
33723372
///
33733373
/// This is an [`IntoIterator`] enabled function that is similar to the standard
3374-
/// library method `Iterator::eq`.
3374+
/// library method [`Iterator::eq`].
33753375
///
33763376
/// ```
33773377
/// assert!(itertools::equal(vec![1, 2, 3], 1..4));
@@ -3396,7 +3396,7 @@ pub fn equal<I, J>(a: I, b: J) -> bool
33963396
}
33973397

33983398
/// Assert that two iterables produce equal sequences, with the same
3399-
/// semantics as *equal(a, b)*.
3399+
/// semantics as [`equal(a, b)`](equal).
34003400
///
34013401
/// **Panics** on assertion failure with a message that shows the
34023402
/// two iteration elements.

src/zip_eq_impl.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ pub struct ZipEq<I, J> {
1414
///
1515
/// **Panics** if the iterators are not of the same length.
1616
///
17-
/// [`IntoIterator`] enabled version of `i.zip_eq(j)`.
17+
/// [`IntoIterator`] enabled version of [`Itertools::zip_eq`](crate::Itertools::zip_eq).
1818
///
1919
/// ```
2020
/// use itertools::zip_eq;

0 commit comments

Comments
 (0)