docs: fix tree in init command docstring
Metadata
Current evaluation
Merged in canonical/charmcraft#2347 (a8da011a), fixing Sphinx rendering of the init command file tree and removing a dead Juju link; 80-column line length remains unchanged.
Resolution: closed resolved
Reason: PR #2347 was merged as commit a8da011a, resolving CHARMCRAFT-629's documentation rendering problem. It also removed a link to a Juju page that no longer exists.
Evaluated by: mr-cal-bot
No scores available.
Issue body
For CHARMCRAFT-629:
- Fix an issue where Sphinx treated the code block of the file tree as a block quote.
- This doesn't fix an underlying issue where the lines are too long on 80-char terminals.
Other:
- Remove a link to a Juju page that no longer exists.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/charmcraft#2347 (a8da011a), fixing Sphinx rendering of the init command file tree and removing a dead Juju link; 80-column line length remains unchanged. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in #2347 as a8da011a, fixing Sphinx rendering of the init command’s file tree and removing a dead Juju link; 80-column overflow remains. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/charmcraft#2347 (a8da011a): fixed Sphinx rendering of the init file tree and removed a dead Juju link; 80-column line lengths remain unfixed. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/charmcraft#2347 (a8da011a), fixing Sphinx rendering of the init command’s file tree and removing a dead Juju link; long lines on 80-column terminals remain unfixed. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation updates for the init command that corrected a Sphinx rendering issue with the file tree code block and removed a broken Juju link. Approved by two reviewers and integrated into the codebase. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation changes that fix Sphinx rendering of a file tree code block in the init command docstring and remove a broken Juju link. Long line lengths on 80-character terminals remain unresolved. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2344 `charmcraft init` tree of files and directories styling issue | charmcraft | closed | Fixed and deployed the charmcraft init file-tree documentation in merged PR #2347 (commit a8da011a), improving tree styling and preventing description line breaks. | |
| #2810 docs: fix terminal directives | charmcraft | merged | Docs-only PR by maintainer jahn-junior merged to fix broken Sphinx terminal directive rendering in 11 documentation files (+225/-266). Author called it a stopgap pending CHARMCRAFT-684; all CI checks passed. | |
| #2095 docs: update Juju links | charmcraft | merged | Merged in canonical/charmcraft#2095 (commit 389f8ca5), updating Juju links and related formatting across 16 files as the rST portion of #2090. | |
| #2136 docs: fix broken references to juju docs | charmcraft | merged | Merged in canonical/charmcraft#2136 (commit fe64df47), fixing six broken Juju documentation references across four docs files alongside juju/juju#18788 and #18790. |