Warnings caused by examples in libstd should fail the doc tests #18199
Assignees
Labels
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
Comments
steveklabnik
added
A-docs
T-rustdoc
|
We definitely want to allow some warnings, like |
|
How about allowing dead_code (and perhaps some other things that are commonly valid for examples), and denying everything else by default? |
|
The reason warnings weren't happening is that they were actually suppressed. |
alexcrichton
added a commit
to alexcrichton/rust
that referenced
this issue
Apr 8, 2015
This adds support in rustdoc to blanket apply crate attributes to all doc tests
for a crate at once. The syntax for doing this is:
#![doc(test(attr(...)))]
Each meta item in `...` will be applied to each doctest as a crate attribute.
cc rust-lang#18199
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Recently, an incorrect example was discovered in the libstd documentation.
In this case, the compiler gives a warning for unused results on the I/O operations.
The example should have checked these results, uncovering a bug, which is the file being opened in read-only mode when it was intended to be written to.
If warnings would fail the doc tests, this issue would have been caught automatically.
In case an example wants to explicitly allow "questionable" constructs, it can use the
allow(lint)attribute.The text was updated successfully, but these errors were encountered: