← Back to issue list

docs: fix tree in init command docstring

View original Github issue

Metadata

Project
charmcraft
Number
#2347
Type
pull request
State
merged
Author
medubelko
Labels
Created
Updated
Closed

Current evaluation

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.

Suggested action:

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
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.
qwen3.6-35b-a3b-mtp-q6 Merged fix for CHARMCRAFT-629 that corrects Sphinx docstring formatting for a file tree code block and removes a broken Juju link. Line length issues on 80-character terminals remain unresolved.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#2136 docs: fix broken references to juju docs charmcraft merged Merged after three reviewer approvals. Corrected broken references to Juju documentation across four files with a six-line addition and six-line removal. The update depends on juju/juju#18790.
74%
#1104 docs: update links craft-parts merged Merged after two reviewers approved. Updated documentation to fix broken links. Integrated into the main branch despite some CI test failures.
73%
#2095 docs: update Juju links charmcraft merged Merged documentation update modifying Juju links and formatting across 16 files. Approved by two reviewers and passed CI checks. Implements a partial update for issue #2090.
73%
#2168 docs: update readme and logo charmcraft merged Merged documentation update replacing the Ubuntu circle logo with the Juju logo on RTD docs and correcting the README link. Approved by two reviewers, passed CI, and resolved a file copying issue prior to merge.
72%
#1243 docs: fix typo in init helper charmcraft merged Merged a documentation fix correcting a typo in the init helper. Approved by two reviewers, the change modified a single line across one file. No CI checks were required.
72%
#2350 docs: fix broken link to Juju docs in template CONTRIBUTING.md charmcraft merged Merged a fix for a broken Juju documentation link in the CONTRIBUTING.md template. Approved by three reviewers and passed CI checks. The change updates the URL to the current equivalent, resolving a 404 error.
71%
#2327 docs: fix some links charmcraft merged Merged a documentation update that corrected several broken links across two files. Approved by two reviewers, the changes were successfully integrated into the main branch, resolving navigation issues in the project documentation.
71%
#6033 docs: fix broken link in README snapcraft merged Merged a documentation fix that corrects a broken link in the README, resolving issue #6031. The change received approval from two reviewers, passed CI validation, and was integrated into the main branch.
70%
#5530 docs: misc fixes snapcraft merged Merged documentation updates removing a Ruby how-to guide and fixing typos based on feedback from PR #5528. Approved by two reviewers and integrated into the codebase.
70%