Skip to content

Commit

Permalink
#148 Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
la10736 committed Jun 19, 2022
1 parent d9678a8 commit 36fe6ff
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Expand Up @@ -226,6 +226,9 @@ async fn group_one_timeout_override(#[case] delay: Duration, #[case] expected: u
}
```

If you want to use `timeout` for `async` test you need to use `async-timeout`
feature (enabled by default).

### Inject Test Attribute

If you would like to use another `test` attribute for your test you can simply
Expand Down
8 changes: 8 additions & 0 deletions rstest/src/lib.rs
Expand Up @@ -226,6 +226,14 @@
//! }
//! ```
//! You can use this feature also in value list and in fixture default value.
//!
//! # Optional features
//!
//! `rstest` Enable all fetures by default. You can disable them if you need to
//! speed up compilation.
//!
//! - **`async-timeout`** *(enabled by default)* — Implement timeout for async
//! tests.

#[doc(hidden)]
pub mod magic_conversion;
Expand Down
3 changes: 3 additions & 0 deletions rstest_macros/src/lib.rs
Expand Up @@ -782,6 +782,9 @@ pub fn fixture(
/// }
/// ```
///
/// If you want to use `timeout` for `async` test you need to use `async-timeout`
/// feature (enabled by default).
///
/// ## Inject Test Attribute
///
/// If you would like to use another `test` attribute for your test you can simply
Expand Down

0 comments on commit 36fe6ff

Please sign in to comment.