Skip to content

Commit fcc9983

Browse files
committed
Document the new feature
1 parent 07b31e3 commit fcc9983

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

test-generator/src/lib.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,15 @@
6161
//!
6262
//! test result: ok. 3 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
6363
//! ```
64+
//! ## Annotating tests to be ignored
65+
//! Sometimes tests should not be run by default, for example if they take a very
66+
//! long time to run. Such tests would usually be annotated with #[ignore].
67+
//! The `test_resources` macro allows to do this by adding the `ignore` keyword
68+
//! after the resource:
69+
//! ```ignore
70+
//! #[test_resources("res/*/input.txt", ignore)]
71+
//! ```
72+
//!
6473
//! # Example usage `bench`:
6574
//!
6675
//! The `bench` functionality requires the nightly release of the Rust-compiler.

0 commit comments

Comments
 (0)