Skip to content

Update detector-arguments.md to show correct argument for Python detectors#1456

Open
mnitchie wants to merge 2 commits intomicrosoft:mainfrom
mnitchie:main
Open

Update detector-arguments.md to show correct argument for Python detectors#1456
mnitchie wants to merge 2 commits intomicrosoft:mainfrom
mnitchie:main

Conversation

@mnitchie
Copy link

@mnitchie mnitchie commented Aug 4, 2025

Correct detector-arguments.md to show the correct category for Python detectors. When using Pip:

$ omponent-detection scan --SourceDirectory . --ManifestFile ./output.json --DetectorCategories Pip
[17:29:15 ERR] An error occurred while executing the command
Microsoft.ComponentDetection.Orchestrator.Exceptions.InvalidDetectorCategoriesException: Categories Pip did not match any available detectors.
   at Microsoft.ComponentDetection.Orchestrator.Services.DetectorRestrictionService.ApplyRestrictions(DetectorRestrictions restrictions, IEnumerable`1 detectors)
   at Microsoft.ComponentDetection.Orchestrator.Services.ScanExecutionService.ExecuteScanAsync(ScanSettings settings)
   at Microsoft.ComponentDetection.Orchestrator.Commands.ScanCommand.ExecuteAsync(CommandContext context, ScanSettings settings)
   at Spectre.Console.Cli.CommandExecutor.Execute(CommandTree leaf, CommandTree tree, CommandContext context, ITypeResolver resolver, IConfiguration configuration) in /_/src/Spectre.Console.Cli/Internal/CommandExecutor.cs:line 166

When using Python:

$ component-detection scan --SourceDirectory . --ManifestFile ./output.json --DetectorCategories Python
[17:41:47 INF] Finding components...

Correct detector-arguments.md to show the correct category for Python detectors
@mnitchie mnitchie requested a review from a team as a code owner August 4, 2025 17:48
@mnitchie mnitchie requested a review from AMaini503 August 4, 2025 17:48
Copilot AI review requested due to automatic review settings March 24, 2026 00:56
@FernandoRojo FernandoRojo enabled auto-merge (squash) March 24, 2026 00:57
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the CLI documentation for --DetectorCategories to reflect the correct category name used by Python-related detectors in Component Detection.

Changes:

  • Replace Pip with Python in the documented list of supported --DetectorCategories values.

detectors that are going to run are the ones that
belongs to the categories.The possible values are:
Npm, NuGet, Maven, RubyGems, Cargo, Pip, GoMod,
Npm, NuGet, Maven, RubyGems, Cargo, Python, GoMod,
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is presented as the output of ... help scan, but the actual CLI help text for --DetectorCategories is sourced from ScanSettings and still lists Pip (not Python). As-is, the docs will no longer match what users see when they run the command shown above; consider updating the ScanSettings option description to Python as well (or adjust this doc to avoid implying the snippet is verbatim CLI output).

Suggested change
Npm, NuGet, Maven, RubyGems, Cargo, Python, GoMod,
Npm, NuGet, Maven, RubyGems, Cargo, Pip, GoMod,

Copilot uses AI. Check for mistakes.
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.

3 participants