docs: document --min-coverage filter option (#4845)#4851
Open
K-Sai-Sujith wants to merge 1 commit intoaboutcode-org:developfrom
Open
docs: document --min-coverage filter option (#4845)#4851K-Sai-Sujith wants to merge 1 commit intoaboutcode-org:developfrom
K-Sai-Sujith wants to merge 1 commit intoaboutcode-org:developfrom
Conversation
Adds comprehensive documentation for the --min-coverage CLI option including: - Detailed explanation of coverage calculation - Multiple use cases with command examples - Before/after output comparison - Performance characteristics
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
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.
Fixes #4845 - Document the --min-coverage CLI option
This PR adds comprehensive documentation for the --min-coverage scan option that was missing from the CLI reference. The new docs explain how the coverage filter works for license and copyright detection matches.
Key additions:
The documentation is added as a new file following the existing CLI reference structure and style. This will help users understand when and how to use the --min-coverage filter to improve scan result quality and reduce false positives.
Tested locally - renders correctly in Sphinx preview.