Skip to content

docs: document --min-coverage filter option (#4845)#4851

Open
K-Sai-Sujith wants to merge 1 commit intoaboutcode-org:developfrom
K-Sai-Sujith:fix-docs-4845-min-coverage
Open

docs: document --min-coverage filter option (#4845)#4851
K-Sai-Sujith wants to merge 1 commit intoaboutcode-org:developfrom
K-Sai-Sujith:fix-docs-4845-min-coverage

Conversation

@K-Sai-Sujith
Copy link

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:

  • Detailed explanation of coverage calculation (matched characters / total rule characters)
  • Three practical use cases: reducing noise (70%), strict analysis (85%), debugging all matches (0%)
  • Real-world command examples for each use case
  • Before/after output comparison showing noise reduction effect
  • Default value (0), valid range (0-100), and performance characteristics
  • Proper RST formatting compatible with Sphinx/ReadTheDocs

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.

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Explain minimum_coverage

1 participant