Document previously undocumented CLI flags in README#601
Merged
Conversation
Adds README sections for flags that had no documentation: --show-uncovered, --show-covered, --src-roots, --report-root-path, --external-css-file, --diff-range-notation, and --ignore-whitespace. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Followup to #600. Several CLI flags had no coverage in the README; this adds sections for them, matching the existing per-feature documentation style.
Newly documented flags:
--show-uncovered(diff-cover) — show uncovered lines on the console--show-covered(diff-cover) — highlight covered diff lines (green) in the HTML report (added in Add --show-covered flag to highlight covered diff lines in HTML report #600)--src-roots(diff-cover) — source directories for jacoco reports--report-root-path(diff-quality) — root path used to generate the report--external-css-file(both) — write report CSS to an external file--diff-range-notation(both) — git diff range notation (...vs..)--ignore-whitespace(both) — ignore whitespace when computing the diffDocs-only change. RST validated with docutils.
🤖 Generated with Claude Code