Skip to content

Commit c03f1da

Browse files
committed
Various docs fixes prior to 0.9
1 parent 1b00867 commit c03f1da

File tree

4 files changed

+16
-15
lines changed

4 files changed

+16
-15
lines changed

README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,11 @@ You can then either add `#[serial]` or `#[serial(some_text)]` to tests as requir
5656

5757
For each test, a timeout can be specified with the `timeout_ms` parameter to the [serial](macro@serial) attribute. Note that
5858
the timeout is counted from the first invocation of the test, not from the time the previous test was completed. This can
59-
lead to some unpredictable behavior based on the number of parallel tests run on the system.
59+
lead to [some unpredictable behavior](https://github.com/palfrey/serial_test/issues/76) based on the number of parallel tests run on the system.
6060
```rust
6161
#[test]
6262
#[serial(timeout_ms = 1000)]
6363
fn test_serial_one() {
6464
// Do things
6565
}
66-
#[test]
67-
#[serial(test_name, timeout_ms = 1000)]
68-
fn test_serial_another() {
69-
// Do things
70-
}
7166
```

serial_test/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ default = ["logging", "async"]
3232
## Switches on debug logging (and requires the `log` package)
3333
logging = ["log"]
3434

35-
## Enables async features
35+
## Enables async features (and requires the `futures` package)
3636
async = ["futures"]
3737

38-
## The file_locks feature unlocks the `file_serial`/`file_parallel` macros
38+
## The file_locks feature unlocks the `file_serial`/`file_parallel` macros (and requires the `fslock` package)
3939
file_locks = ["fslock"]
4040

4141
docsrs = ["document-features"]

serial_test/src/lib.rs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,18 @@
4545
//! // Do things
4646
//! }
4747
//! ````
48+
//!
49+
//!
50+
//! For each test, a timeout can be specified with the `timeout_ms` parameter to the [serial](macro@serial) attribute. Note that
51+
//! the timeout is counted from the first invocation of the test, not from the time the previous test was completed. This can
52+
//! lead to [some unpredictable behavior](https://github.com/palfrey/serial_test/issues/76) based on the number of parallel tests run on the system.
53+
//! ```rust
54+
//! #[test]
55+
//! #[serial(timeout_ms = 1000)]
56+
//! fn test_serial_one() {
57+
//! // Do things
58+
//! }
59+
//! ```
4860
//!
4961
//! ## Feature flags
5062
#![cfg_attr(

serial_test_derive/src/lib.rs

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,20 +64,14 @@ use std::ops::Deref;
6464
///
6565
/// For each test, a timeout can be specified with the `timeout_ms` parameter to the [serial](macro@serial) attribute. Note that
6666
/// the timeout is counted from the first invocation of the test, not from the time the previous test was completed. This can
67-
/// lead to some unpredictable behavior based on the number of parallel tests run on the system.
67+
/// lead to [some unpredictable behavior](https://github.com/palfrey/serial_test/issues/76) based on the number of parallel tests run on the system.
6868
///
6969
/// ````
7070
/// #[test]
7171
/// #[serial(timeout_ms = 1000)]
7272
/// fn test_serial_one() {
7373
/// // Do things
7474
/// }
75-
///
76-
/// #[test]
77-
/// #[serial(timeout_ms = 1000)]
78-
/// fn test_serial_another() {
79-
/// // Do things
80-
/// }
8175
/// ````
8276
///
8377
/// Nested serialised tests (i.e. a [serial](macro@serial) tagged test calling another) are supported

0 commit comments

Comments
 (0)