docs: fix doctest error #523
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
For doctests, there is no keyword `no-run`. Doctests recognizes `no_run`, but this still compiles the code, which will fail in this case. We could fixup these examples with some hidden lines so that they compile, but since we don't really use rustdoc currently, let's just have the compiler ignore these examples. Signed-off-by: Tobin Feldman-Fitzthum <[email protected]>
Xynnn007
approved these changes
Oct 8, 2024
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.
For doctests, there is no keyword
no-run.Doctests recognizes
no_run, but this still compiles the code, which will fail in this case.We could fixup these examples with some hidden lines so that they compile, but since we don't really use rustdoc currently, let's just have the compiler ignore these examples.