Add guide for running doctest #4393
Merged
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
daxpedda
requested changes
Jan 7, 2025
guide/src/wasm-bindgen-test/usage.md
Outdated
| If you also need to run doctests, add the [`-Zdoctest-xcompile`](https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#doctest-xcompile) flag: | ||
|
|
||
| ``` | ||
| cargo -Zdoctest-xcompile test --target wasm32-unknown-unknown |
There was a problem hiding this comment.
It looks like a positional argument this way, so lets put it at the end:
Suggested change
| cargo -Zdoctest-xcompile test --target wasm32-unknown-unknown | |
| cargo test --target wasm32-unknown-unknown -Zdoctest-xcompile |
guide/src/wasm-bindgen-test/usage.md
Outdated
Comment on lines
137
to
141
| If you are in the stable channel, you can switch to nightly like this: | ||
|
|
||
| ``` | ||
| cargo +nightly -Zdoctest-xcompile test --target wasm32-unknown-unknown | ||
| ``` |
There was a problem hiding this comment.
Instead we should note that his is an unstable feature that requires Rust nightly and merge these two blocks.
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.
This is what I learned recently when trying to run doctests:
