Add support for compiling examples with --test to rustdoc & update the testing guide #15039
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
Fields have names, unlike an anonymous tuple.
This adds the `test_harness` directive that runs a code block using the test runner, to allow for `#[test]` items to be demonstrated and still tested (currently they are just stripped and not even compiled, let alone run).
| b.iter(|| { | ||
| // note lack of `;` (could also use an explicit `return`). | ||
| range(0, 1000).fold(0, |old, new| old ^ new) | ||
| }); |
There was a problem hiding this comment.
While you're at it, could you de-indent these examples? I'm not sure why the body is indented twice and the last brace/paren is indented once.
|
r=me, just one minor comment |
rustdoc now supports compiling things with `--test` so the examples in this guide can be compiled & tested properly (revealing a few issues & out-dated behaviours). Also, reword an example to be clearer, cc rust-lang#12242.
bors
added a commit
that referenced
this pull request
Jun 20, 2014
```test_harness
#[test]
fn foo() {}
```
will now compile and run the tests, rather than just ignoring & stripping them (i.e. it is as if `--test` was passed).
Also, the specific example in #12242 was fixed (but that issue is broader than that example).
lnicola
pushed a commit
to lnicola/rust
that referenced
this pull request
Jun 19, 2023
fix: Use a more obscure hasher name in derive expansion Closes rust-lang#15039
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.
will now compile and run the tests, rather than just ignoring & stripping them (i.e. it is as if
--testwas passed).Also, the specific example in #12242 was fixed (but that issue is broader than that example).