← Back to issue list

Present long/short options separated in the options table for markdown formatted help

View original Github issue

Metadata

Project
craft-cli
Number
#114
Type
issue
State
open
Author
facundobatista
Labels
Created
Updated
Closed

Current evaluation

Request to render short and long CLI options in separate columns of the markdown help options table (e.g. | -v | --verbose | desc |) instead of combined '-v, --verbose'. Unlabelled, zero comments, and the current code still uses the combined format.

Suggested action: needs triage

Reason: The issue has no labels, no comments, and no assignee, showing no sign of categorisation, so it needs triage. It is not stale-closable: I verified craft_cli/helptexts.py's _build_markdown_command_help still emits the combined format (tests expect '| `-h, --help` | ... |'), so the request remains applicable. It is a low-priority cosmetic formatting suggestion, so impact is minimal.

Impact: 15 Quick Win: 11.25 Staleness: 80 Complexity: 25 Confidence: 80 Support Request: 0

Issue body

IOW, we should have ``` | -v | --verbose | put stuff in verbose | | | --verbosity | set verbosity level | ``` instead of ``` | -v, --verbose | put stuff in verbose | | --verbosity | set verbosity level | ```

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 15
Quick Win: 11.25
Staleness: 80
Complexity: 25
Confidence: 80
Support Request: 0
needs triage Request to render short and long CLI options in separate columns of the markdown help options table (e.g. | -v | --verbose | desc |) instead of combined '-v, --verbose'. Unlabelled, zero comments, and the current code still uses the combined format.
qwen/qwen3.6-35b-a3b
Staleness: 85
Complexity: 25
Confidence: 75
Support Request: 10
needs triage Formatting suggestion to display long and short CLI options in separate columns for markdown help output. Unlabelled, zero comments, inactive for over a year.
qwen3.6-35b-a3b-mtp-q6
Staleness: 88
Complexity: 10
Confidence: 70
Support Request: 5
needs triage Feature request to separate short and long CLI options into distinct columns in markdown help tables. Unaddressed for over three years with no maintainer comments or labels.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 25
Confidence: 65
Support Request: 10
needs triage Separate short and long CLI options into distinct columns in markdown help tables instead of combining them. Open issue with no comments or labels, inactive for over a year, awaiting triage and assignment.

Update history

No update history recorded yet.

Related work

  • Related To: craft-cli#113 (confidence 60%)

    PR 'help-markdown-options-table' introduced the markdown options table that this issue proposes to restructure into separate short/long columns.

Related issues

No related issues found above the similarity threshold.