Add support for no_run info string #5
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
This commit adds support for the `no_run` info string which works similar to how it works for rustdoc (code is compiled but not executed). Blocks marked as `no_run` result in a generated function that is dead code (does not have `test` attribute applied). This is pretty useful for examples in documentation which have side effects and would frequently fail or do undesirable things in a test environment. I also updated the documentation to make getting details on each info string a bit simpler. Signed-off-by: Paul Osborne <[email protected]>
|
Thanks so much! |
|
I published 0.5.0 with your change. |
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 commit adds support for the
no_runinfo stringwhich works similar to how it works for rustdoc (code is
compiled but not executed). Blocks marked as
no_runresult in a generated function that is dead code (does
not have
testattribute applied).This is pretty useful for examples in documentation which
have side effects and would frequently fail or do
undesirable things in a test environment.
I also updated the documentation to make getting details on
each info string a bit simpler.