Fix DetectorCategories documentation - replace Pip with Python and add missing categories #1446
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 documentation for
--DetectorCategories
contained incorrect possible values. Specifically, it listedPip
as a valid category, but Python ecosystem detectors actually usePython
as their category.Issue
The current documentation states:
However, when examining the actual detector implementations:
PipComponentDetector
uses["Python"]
as its categorySimplePipComponentDetector
uses["Python"]
as its categoryPipReportComponentDetector
uses["Python"]
as its category["Python"]
This means users trying to filter Python dependencies with
--DetectorCategories Pip
would get no results.Solution
Updated both documentation locations to:
Pip
withPython
in the categories listUpdated documentation
Usage examples
Files changed
docs/detector-arguments.md
- Updated help documentationsrc/Microsoft.ComponentDetection.Orchestrator/Commands/ScanSettings.cs
- Updated command-line descriptionFixes #1435.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.