Skip to content

Commit

Permalink
Merge pull request #48 from torfsen/42-clarify-docs
Browse files Browse the repository at this point in the history
Clarify docs for tests not marked as `serial`
  • Loading branch information
palfrey committed Dec 26, 2021
2 parents c16b9ed + 6b5aef0 commit 418791f
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,9 @@ async fn test_serial_another() {
}
```
Multiple tests with the `serial` attribute are guaranteed to be executed in serial. Ordering of the tests is not guaranteed however.
Note that if you're using an async test reactor attribute (e.g. `tokio::test` or `actix_rt::test`) then they should be listed *before*
`serial`, otherwise we don't get an async function and things break. There's now an error for this case to improve debugging.
Tests without the `serial` attribute may run at any time, including in parallel to tests marked as `serial`. Note that if you're using
an async test reactor attribute (e.g. `tokio::test` or `actix_rt::test`) then they should be listed *before* `serial`, otherwise we
don't get an async function and things break. There's now an error for this case to improve debugging.

## Usage
We require at least Rust 1.39 for [async/await](https://blog.rust-lang.org/2019/11/07/Async-await-stable.html) support
Expand Down

0 comments on commit 418791f

Please sign in to comment.