fix(docs): ignore shell command in README doctest - #19
Merged
Conversation
Contributor
Author
|
@clearloop I hope this little change helps first |
clearloop
approved these changes
Oct 13, 2025
clearloop
left a comment
clearloop
left a comment
Contributor
There was a problem hiding this comment.
LGTM! could you please add doc tests to the CI as well in this PR?
Contributor
Author
|
Alright @clearloop , currently AFK will do that later. |
clearloop
approved these changes
Oct 15, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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 project test suite was failing when running cargo test. the failure was caused by documentation test that was incorrectly trying to compile the shell command in the readme file
this changes resolve the issues by adding the
ignoreflag to the code block in the readme. it allow the test runner to skip the code blocks, preventing the compilation errors. so now thecargo testcommand now completes succesfully