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

trpl: add a small section outlining doctest configuration

Browse Source
This commit is contained in:
Kevin Butler 2015-11-03 16:42:25 +00:00
parent 8e23e2fbcb
commit 5ae1937129
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/doc/trpl/documentation.md
View File

@ -620,6 +620,18 @@ You can control a few aspects of the HTML that `rustdoc` generates through the
This sets a few different options, with a logo, favicon, and a root URL.
### Configuring documentation tests
You can also configure the way that `rustdoc` tests your documentation examples
through the `#![doc(test(..))]` attribute.
```rust
#![doc(test(attr(allow(unused_variables), deny(warnings))))]
```
This allows unused variables within the examples, but will fail the test for any
other lint warning thrown.
## Generation options
`rustdoc` also contains a few other options on the command line, for further customization: