diff options
| author | Dylan DPC <99973273+Dylan-DPC@users.noreply.github.com> | 2022-04-15 20:50:51 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-04-15 20:50:51 +0200 |
| commit | 18a7ce32b68bf9e3ed3f7f516ed254a5e86a7851 (patch) | |
| tree | 1e17b9cccbfa2cb8fb845a6eedc049678c2ec541 | |
| parent | aa978addb3cffceb6f1020787369d07f65cf15b7 (diff) | |
| parent | 5459e6637ae4cd86367927753df6e7fbe1c503e1 (diff) | |
Rollup merge of #96062 - ehuss:test-termination, r=Dylan-DPC
docs: Update tests chapter for Termination stabilization A small update for the docs of `#[test]` functions as a result of the `Termination` stabilization in #93840.
| -rw-r--r-- | src/doc/rustc/src/tests/index.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/src/doc/rustc/src/tests/index.md b/src/doc/rustc/src/tests/index.md index 0e0eb85db74..32baed9c944 100644 --- a/src/doc/rustc/src/tests/index.md +++ b/src/doc/rustc/src/tests/index.md @@ -15,7 +15,8 @@ fn it_works() { ``` Tests "pass" if they return without an error. They "fail" if they [panic], or -return a [`Result`] with an error. +return a type such as [`Result`] that implements the [`Termination`] trait +with a non-zero value. By passing the [`--test` option] to `rustc`, the compiler will build the crate in a special mode to construct an executable that will run the tests in the @@ -304,6 +305,7 @@ Experimental support for using custom test harnesses is available on the [`libtest`]: ../../test/index.html [`main` function]: ../../reference/crates-and-source-files.html#main-functions [`Result`]: ../../std/result/index.html +[`Termination`]: ../../std/process/trait.Termination.html [`test` cfg option]: ../../reference/conditional-compilation.html#test [attribute-ignore]: ../../reference/attributes/testing.html#the-ignore-attribute [attribute-should_panic]: ../../reference/attributes/testing.html#the-should_panic-attribute |