Fix (README.md): Add sh language to bare code fences to avoid doctest…#7
Open
edmundlod wants to merge 1 commit into
Open
Fix (README.md): Add sh language to bare code fences to avoid doctest…#7edmundlod wants to merge 1 commit into
edmundlod wants to merge 1 commit into
Conversation
… failures
Bare ``` fences in README.md are interpreted as Rust code blocks by the doctest runner (via include_str!("../README.md") in `lib.rs`), causing test failures.
Adding sh as the language specifier marks them as non-Rust, so cargo test no longer tries to compile shell commands as Rust code.
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
1 participant
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.
Bare ``` fences in README.md are interpreted as Rust code blocks by the doctest runner (via include_str!("../README.md") in
lib.rs), causing test failures.Adding
sh(and onetext) as the language specifier marks them as non-Rust, so cargo test no longer tries to compile shell commands as Rust code.