Skip to content

Commit 0783e9c

Browse files
committed
Mark gix-pack vendored izip! doctest ignore
That macro is not exported, and adjusting the doctest so that it can run successfully (or even compile) might be tricky without a significant change (or adding dependencies). This fixes a failure when running doctests for the whole workspace (as CI now includes). This change is not "user-facing", as the macro is not part of the public interface of `gix_pack`. Its documentation comment doesn't appear https://docs.rs/gix-pack/0.54.0/gix_pack/index/index.html. Nonetheless, this adds a note to clarify the change, to avoid attributing it to the original code from which this was vendored.
1 parent da87bec commit 0783e9c

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

gix-pack/src/index/mod.rs

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//! an index into the pack file
2-
//!
2+
33
/// From itertools
44
/// Create an iterator running multiple iterators in lockstep.
55
///
@@ -21,7 +21,7 @@
2121
///
2222
/// [`multizip`]: fn.multizip.html
2323
///
24-
/// ```
24+
/// ```ignore
2525
/// # use itertools::izip;
2626
/// #
2727
/// # fn main() {
@@ -37,6 +37,9 @@
3737
/// assert_eq!(results, [0 + 3, 10 + 7, 29, 36]);
3838
/// # }
3939
/// ```
40+
///
41+
/// (The above is vendored from [itertools](https://github.com/rust-itertools/itertools),
42+
/// including the original doctest, though it has been marked `ignore` here.)
4043
macro_rules! izip {
4144
// @closure creates a tuple-flattening closure for .map() call. usage:
4245
// @closure partial_pattern => partial_tuple , rest , of , iterators

0 commit comments

Comments
 (0)