Fix top-level doctest #22
Merged
Conversation
This file contains hidden or 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
The way the `std::process::exit` call in the top level doctest is currently commented out is somewhat confusing to readers (or at least does not flow well); this commit instead wraps it in a hidden `if false { ... }`, which will prevent it from running without affecting what the documentation looks like.
dpc
approved these changes
Dec 8, 2020
Member
|
@dpc please merge 😉 |
Contributor
|
@Techcable Try now? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
The way the
std::process::exitcall in the top level doctest is currently commented out is somewhat confusing to readers (or at least does not flow well); this commit instead wraps it in a hiddenif false { ... }, which will prevent it from running without affecting what the documentation looks like.