Remove sphinx directives from overview texts
Metadata
Current evaluation
Enhancement: strip reST/sphinx directives from command overview texts, extending the double-backtick removal done in #306; triaged, linked to CRAFT-4623, still unimplemented in helptexts.py
Suggested action: keep open
Reason: Filed by maintainer lengau, labelled 'Status: Triaged' and 'Type: Enhancement', with the sole comment being the Jira sync (CRAFT-4623) — so it is valid, assessed work that is still outstanding. Code confirms it is not resolved: helptexts.py only strips reST double backticks (re.sub(r'(?<!`)``(?!`)', '', overview), line 327) and greps for 'directive'/'code::' in craft_cli/ return no matches, so nothing handles directives like '.. code:: bash' in either the plain or the process_overview_for_markdown path. Confidence is tempered because the issue does not enumerate which directives/roles to strip, so the implementation scope needs a maintainer decision.
Evaluated by: mr-cal-bot
Issue body
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha |
Impact:
35
Quick Win:
19
Complexity:
25
Confidence:
72
Actionability:
72
|
keep open | Enhancement: strip reST/sphinx directives from command overview texts, extending the double-backtick removal done in #306; triaged, linked to CRAFT-4623, still unimplemented in helptexts.py | |
| qwen/qwen3.6-35b-a3b |
Impact:
30
Quick Win:
16
Complexity:
10
Confidence:
60
Actionability:
60
|
keep open | Enhancement to remove sphinx directives from command overview texts, similar to #306 which removed code backticks. No sphinx directives currently found in overview strings. | |
| qwen/qwen3.8-27b |
Impact:
35
Quick Win:
23
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
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. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/craft-cli#306
(confidence 88%)
Explicitly cited in the issue body as the pattern to follow; merged as commit f547a04 'feat: remove code backticks in CLI help messages' and the only existing reST cleanup in helptexts.py.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #510 fix: strip Sphinx roles and directives from plain help overviews | craft-cli | open | Adds plain-help stripping for Sphinx roles and directive markers while preserving content and Markdown output; tests are included, but the PR awaits maintainer review. |