microsoft / microsoft/component-detection

DetectorCategories Argument Documentation Incorrect

Open
#1,435 0 comments 1 reaction 1 assignee View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
553
Forks
135
Avg merge
20h 58m
Merged PRs (30d)
6

Description

In the documentation for[ detector arguments](https://github.com/microsoft/component-detection/blob/main/docs/detector-arguments.md) it states that the `--DetectorCategories` arguments possible values are: Npm, NuGet, Maven, RubyGems, Cargo, Pip, GoMod, CocoaPods, Linux.

```
--DetectorCategories A comma separated list with the categories of
components that are going to be scanned. The
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,
CocoaPods, Linux.
```

This is incorrect for at least `Pip`. `Pip` will not work. For Python ecosystems the --DetectorCategories needs to be `Python` and will use all the python detectors.

Can the documentation be corrected?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.