chocolatey / chocolatey/choco

Make version requirements in choco help clearer

Open
#2,097 0 comments 1 reaction 0 assignees View on GitHub
0 - Triaging Enhancement
Dominant language
C#
Stars
11.5k
Forks
960
PR merge metrics
No merged PRs in 30d

Description

The help that covers the Chocolatey parameters states that specific versions of Chocolatey / Chocolatey For Business is required. An example of this is (`choco source -?`):

```
--adminonly, --admin-only
Visible to Administrators Only - Should this source be visible to non-
administrators? **Requires business edition (v1.12.2+). Defaults to false.
Available in 0.10.8+**.
```

(emphasis mine).

This is very confusing as it's not clear what is actually required. The requirements for this parameter is:

* Chocolatey Licensed Extension 1.12.2 or later.
* Chocolatey 0.10.8 or later.

We should make sure that the help, for all parameters (not just the one above), is clear on what the specific requirements are.

Contributor guide

Open the contributing guide

Research direction

Start by running `choco source -?` and reviewing the help-generation or parameter-definition entry points for `--adminonly`/`--admin-only`. Compare the displayed requirements with the stated Chocolatey Licensed Extension and Chocolatey version requirements, then check the help for all parameters and update any similarly ambiguous wording.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.