mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rollup merge of #96062 - ehuss:test-termination, r=Dylan-DPC

Browse Source 
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.
This commit is contained in:
Dylan DPC 2022-04-15 20:50:51 +02:00 committed by GitHub
commit 18a7ce32b6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/doc/rustc/src/tests/index.md
View File

@ -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