Fix ignored doctests #753

Philippe-Cholet · 2023-09-19T14:50:41Z

Doctest attribute	What it means
text	Not code.
ignore	It is ignored by default but might run, e.g. `cargo test -- --ignored`.
should_panic	It must compile but panic at runtime.
no_run	It must compile but is not run.
compile_fail	It must not compile.
edition2018	Only runs on the given edition.

Personally, I annotate with "ignore" when it's slow and I don't want to run it every time.
Otherwise, I think another attribute should be used.

This doctest can not run because this function (and module) is private.

But it should compile at it is code.

jswrenn

Thanks!

Philippe-Cholet added 3 commits September 19, 2023 16:13

Fix ignored doctest of size_hint::mul

356eb89

This doctest can not run because this function (and module) is private.

assert_equal doctest should not be ignored but panic

fe51f6f

fold_ok small doctest: no run

dac0a1a

But it should compile at it is code.

jswrenn approved these changes Sep 20, 2023

View reviewed changes

jswrenn added this pull request to the merge queue Sep 20, 2023

Merged via the queue into rust-itertools:master with commit a104321 Sep 20, 2023

Philippe-Cholet deleted the ignored-tests branch September 20, 2023 14:25

jswrenn mentioned this pull request Nov 14, 2023

prepare v0.12.0 release #802

Merged

jswrenn added this to the next milestone Nov 14, 2023

Provide feedback