← Back to issue list

docs: fix parameter names showing as None in CLI usage docs

View original Github issue

Metadata

Project
charmcraft
Number
#2671
Type
pull request
State
open
Author
Copilot
Labels
Created
2026-04-22 04:48:08+00:00
Updated
2026-04-22 04:52:31+00:00
Closed

Current evaluation

Fixes CLI documentation where required argument metavars incorrectly display as <None> by falling back to argparse conventions, with the draft pull request currently awaiting maintainer approval.

Suggested action: needs triage

Reason: The PR has no labels, no maintainer comments, and has been inactive for 54 days. Despite a clear fix and passing CI/CodeQL, it requires official triage and review before being merged or closed.

Staleness: 35 Complexity: 15 Confidence: 75

Issue body

- [x] Investigated CI failures on main and open PRs - [x] Found and fixed bug in `tools/docs/gen_cli_docs.py`: required argument metavars show as `<None>` in usage strings when `metavar` is not explicitly set (fixes #2578, #2642) - [x] Fix falls back to argparse convention: positional args use `dest`, optional args use `dest.upper()` - [x] Code review and CodeQL security scan both pass - [x] Draft PR #2671 created - [x] CI is in `action_required` state (needs maintainer approval - standard for Copilot PRs) **Other CI failures found on main (documented below, no simple fix in charmcraft):** - [x] `snap-store-tests` failing: Charmhub credentials expired (infrastructure issue) - [x] `snap-tests (ubuntu-22.04/20.04)`: `smoketests/different-dir-metadata` fails due to craft_providers snapd initialization issue (upstream issue in craft_providers; see PR #2509) - [x] `snap-tests (ubuntu-26.04)`: Transient apt package unavailability on Ubuntu devel daily builds (`gcc` and `python3-dev` not found) — not fixable in charmcraft - [x] Spread tests have been failing consistently since at least March 2026 (all due to upstream issues)

Evaluation history

Date Model Scores Action Summary
2026-06-15 11:32:23.543150+00:00 qwen3.6-35b-a3b-mtp-q6
Staleness: 35
Complexity: 15
Confidence: 75
needs triage Fixes CLI documentation where required argument metavars incorrectly display as <None> by falling back to argparse conventions, with the draft pull request currently awaiting maintainer approval.
2026-06-15 11:30:14.633518+00:00 pending