Remove sphinx directives from overview texts
Metadata
Current evaluation
Enhancement to strip sphinx directives (e.g. :doc:, :ref:) from command overview texts in CLI help output, following the precedent of #306 which removed reST double backticks. Triaged by maintainer, no PR or assignee, dormant ~14 months.
Suggested action: keep open
Reason: The issue is triaged (labeled Status: Triaged, Type: Enhancement) and the underlying problem is confirmed still present: craft_cli/helptexts.py line 327 only strips reST double backticks via re.sub(r"(?<!`)``(?!`)", "", overview) but does not handle sphinx role directives like :doc: or :ref:. The referenced use case (charmcraft PR #2347) and the precedent (#306, merged) make the scope clear. No PR has been filed and no assignee is set, so it remains a valid open enhancement.
Issue body
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.8-27b |
Impact:
35
Quick Win:
22.75
Staleness:
75
Complexity:
35
Confidence:
78
Support Request:
0
|
keep open | Enhancement to strip sphinx directives (e.g. :doc:, :ref:) from command overview texts in CLI help output, following the precedent of #306 which removed reST double backticks. Triaged by maintainer, no PR or assignee, dormant ~14 months. | |
| qwen/qwen3.8-27b |
Impact:
35
Quick Win:
26.25
Staleness:
72
Complexity:
25
Confidence:
72
Support Request:
0
|
keep open | Enhancement to strip sphinx directives (e.g. :ref:, :doc:) from command overview texts in CLI help output, following the backtick-removal work in #306. Triaged by maintainer, no implementation yet; last activity was the Jira sync bot 432 days ago. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
85
Complexity:
15
Confidence:
75
Support Request:
0
|
keep open | Enhancement to remove Sphinx directives from overview texts. Triaged by a maintainer but inactive for over a year with no implementation progress or further discussion. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
90
Complexity:
15
Confidence:
80
Support Request:
5
|
keep open | Enhancement to remove Sphinx directives from overview texts, mirroring #306. Labeled triaged by a maintainer but has been inactive for over a year with only a Jira sync bot comment. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
80
Complexity:
20
Confidence:
85
Support Request:
0
|
keep open | Remove Sphinx directives from overview texts to improve compatibility and readability. Triaged as an enhancement, the request has been inactive for over a year and awaits assignment or implementation. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/craft-cli#306
(confidence 90%)
PR #306 (merged) removed reST double backticks from CLI help overviews; this issue is a direct follow-up extending that cleanup to sphinx role directives like :doc: and :ref:.
Related issues
No related issues found above the similarity threshold.