Clarify `charmcraft status --help` text for `--format`
Metadata
Current evaluation
Closed without a linked fix or PR, likely abandoned. The misleading help text for charmcraft status --format remains unupdated.
Suggested action: —
No scores available.
Issue body
#784 implements structured output of `charmcraft status`, but the help text on it is a bit misleading:
```
base ❯ time charmcraft status --help
Usage:
charmcraft status [options] <name>
...
Options:
...
--format: Produce the result formatted as a JSON string
```
The above makes it seem like `charmcraft status charmname --format` will export in JSON, but really it wants `--format json`. Easy to fix by changing the option string to say it needs an extra arg, one of `json` or whatever else is available.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen3.6-35b-a3b-mtp-q6 | — | — | Closed without a linked fix or PR, likely abandoned. The misleading help text for charmcraft status --format remains unupdated. | |
| qwen/qwen3.6-35b-a3b | — | — | Fixed. The charmcraft status --format help text was updated to clarify the flag requires an argument. Closed without a linked pull request. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Closed without resolution. The misleading help text for the --format flag in charmcraft status was not updated to indicate it requires an explicit argument. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Closed without resolution. The misleading help text for the --format flag in charmcraft status was not updated, leaving the requirement for an explicit argument unclarified. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #933 Update the charmcraft status --format | charmcraft | merged | Merged after the author removed YAML formatting support per reviewer feedback, keeping only the help text update for the --format option. The PR was approved and merged following the requested changes. | |
| #940 Add yaml formatting feature in charmcraft status | charmcraft | closed | The request to add YAML formatting to charmcraft status was abandoned. The maintainer clarified the format flag is for machine consumption, not human readability. The author agreed and closed the issue. |