chocolatey / chocolatey/choco

Change help for the `choco search` command to expand on `--all-versions` option

Open
#3,755 1 comment 2 reactions 0 assignees View on GitHub
0 - Backlog Documentation
Dominant language
C#
Stars
11.5k
Forks
960
PR merge metrics
No merged PRs in 30d

Description

### Checklist

- [x] I have verified this is the correct repository for opening this issue.
- [x] I have verified no other issues exist related to my request.

### Is Your Feature Request Related To A Problem? Please describe.

In the help for the `choco search` command, the `--all-versions` option states:

```
-a, --all, --allversions, --all-versions
AllVersions - include results from all versions.
```

While this is technically true, I feel it could be expanded to be clearer and have more detail. Before I got clarification, I would've expected that passing `--all-versions` would get me _all versions_; prereleases included. I'd like to see the help changed to be clearer with what's actually happening, like this:

```
-a, --all, --allversions, --all-versions
AllVersions - include results from all stable versions. To include results for all packages, add --prerelease to the command.
```
Or something similar. I'm happy to workshop this more until we get it where we like it.

### Describe The Solution. Why is it needed?

Clear documentation provides users with the ability to help themselves. Documentation can never be _too_ helpful.

### Additional Context

N/A

### Related Issues

- [Internal issue](https://gitlab.com/chocolatey/solutions/support-issues/-/issues/139)

Contributor guide

Open the contributing guide

Research direction

Search the repository for the exact `AllVersions - include results from all versions.` help text and inspect the surrounding `choco search` command documentation. Update the `--all-versions` description to clarify stable-version behavior and how `--prerelease` affects results, then verify the revised text in the command help.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
cli, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.