Add precision about which files will have their documentation examples tested #80649
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rust-highfive
added
the
S-waiting-on-review
jyn514
reviewed
Jan 3, 2021
| @@ -3,6 +3,9 @@ | |||
| `rustdoc` supports executing your documentation examples as tests. This makes sure | |||
| that examples within your documentation are up to date and working. | |||
|
|
|||
| Before going any further, please note that only documentation examples in the source | |||
| code are run. So if you have ones in your `tests` folder files, they won't be run. | |||
There was a problem hiding this comment.
This seems like it should be part of the Cargo docs or the book. Rustdoc doesn't assign any meaning to src/ or tests/.
There was a problem hiding this comment.
Or in other words, if you use rustdoc --test directly it works fine. It's only going through cargo that breaks.
$ rustdoc --test tests/doc.rs
running 1 test
test tests/doc.rs - (line 1) ... FAILED
failures:
---- tests/doc.rs - (line 1) stdout ----
Test executable failed (exit code 101).
stderr:
thread 'main' panicked at 'assertion failed: `(left == right)`
left: `1`,
right: `2`', tests/doc.rs:3:1
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
There was a problem hiding this comment.
That's a good point. I'll comment that on the issue. Closing this PR then!
jyn514
added
S-waiting-on-author
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #79587.
cc @robinst
Having a second opinion on the wording from a native english speaker would be very useful here.
r? @jyn514