feat: error early when help message is missing
Metadata
Current evaluation
Raises a CommandError during help generation when an argument lacks help text, fixing the IndexError from #242. Small 2-file diff (+52/-50), all CI checks green; awaiting maintainer review with 1 unresolved comment, inactive 32 days.
Suggested action: needs review
Reason: The PR directly addresses the maintainer-triaged issue #242 ('Unhelpful error message when creating help if an argument doesn't have a help text'), whose summary states the maintainer directed resolution to this PR, and the diff is a focused +52/-50 across 2 files with every CI check passing (fast + slow tests across 3.10-3.14, freethreaded, arm, macOS, lint, CLA, policy, zizmor, OSV). It is not yet approved though: review status is 'pending (0 reviewers)' with 1 unresolved review comment and no activity for 32 days, so it needs a maintainer to look rather than being merge-ready. Confidence is capped because repo inspection tooling had no pinned SHA for craft-cli, so I could not verify the exact code path raising the new error or the test coverage in the diff.
Evaluated by: mr-cal-bot
Issue body
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha |
Impact:
40
Quick Win:
18
Complexity:
32
Confidence:
68
Actionability:
66
|
needs review | Raises a CommandError during help generation when an argument lacks help text, fixing the IndexError from #242. Small 2-file diff (+52/-50), all CI checks green; awaiting maintainer review with 1 unresolved comment, inactive 32 days. | |
| stealth/space-bunny-alpha |
Impact:
44
Quick Win:
25
Complexity:
28
Confidence:
93
Actionability:
78
|
needs review | Raises an early configuration error for missing help text, preventing the help flow from later failing with an IndexError. All CI checks pass; maintainer review remains pending. | |
| qwen3.6-35b-a3b-mtp-q6 |
Impact:
50
Quick Win:
42
Staleness:
10
Complexity:
15
Confidence:
75
|
needs review | Raises a command configuration error when help text is missing instead of crashing with an IndexError. Passing CI, awaiting review. |
Update history
| Date | Change |
|---|---|
| updated | |
| updated | |
| created |
Related work
-
Related To:
canonical/craft-cli#242
(confidence 95%)
Explicitly referenced as 'Fixes #242' in the PR body; the issue's own summary confirms the maintainer routed the unhelpful-help-text/IndexError report to this PR, and it remains open pending it.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #242 Unhelpful error message when creating help if an argument doesn't have a help text | craft-cli | open | Help output for a command whose argument lacks help text renders badly (originally IndexError) instead of a clear error. Maintainer directed resolution to PR #481 (fail early on missing help), which is still open. |