← Back to issue list

Small text cleanups for README and charmcraft help

View original Github issue

Metadata

Project
charmcraft
Number
#188
Type
pull request
State
merged
Author
markshuttle
Labels
—
Created
Updated
Closed

Current evaluation

Merged README and charmcraft help-text cleanups in ffc44697, updating 13 files after approval by two reviewers.

Resolution: closed resolved

Reason: PR #188 was merged into the main branch as commit ffc44697 after approval by two reviewers.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Lots of text work, I tried not to change anything that might break tests but the occasional %s might have slipped through :)

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged README and charmcraft help-text cleanups in ffc44697, updating 13 files after approval by two reviewers.
stealth/space-bunny-alpha — closed resolved Merged README and charmcraft help-text cleanups after approval by two reviewers, updating 13 files.
stealth/space-bunny-alpha — closed resolved Merged as ffc44697: cleaned up Charmcraft's README and command help text across 13 files, following approval by two reviewers.
qwen/qwen3.6-35b-a3b — — Merged text cleanups for the README and charmcraft help documentation. Approved by two reviewers, the change updates 13 files to improve clarity while preserving test compatibility.
qwen3.6-35b-a3b-mtp-q6 — — Merged external contribution applying minor text cleanups to the README and charmcraft help documentation. Changes improved readability while preserving test compatibility.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#1434 Improve Documentation for 'charmcraft help clean' Command charmcraft open Documentation request for `charmcraft clean` help text; current overview is brief and issue lacks specific gaps. Related PR #2795 was rejected as subpar; no maintainer triage on issue.
75%
#2795 docs: improve `charmcraft clean` command documentation charmcraft closed Closed unmerged; maintainer @lengau rejected the proposed charmcraft clean documentation as subpar, and no documentation commit or replacement PR landed.
73%
#2229 style: fix linting errors charmcraft merged Merged charmcraft#2229 as commit 134e1cb6, fixing lint failures from the latest Ruff and Pyright across eight files.
72%
#2299 docs: fix formatting issues charmcraft merged Merged docs formatting fixes for local documentation builds in charmcraft#2299 via commit 5ffb80fe; two files changed (+3/-1).
72%
#1341 [JUJU-4554] Update the README to simplify and better align with docs charmcraft merged Docs-only PR merged as commit 647a605c (#1341): rewrote Charmcraft's README (+62/-118) to a shorter intro placing Charmcraft in the Juju/Charm SDK ecosystem and linking to Charm SDK docs instead of Multipass install steps.
71%
#2010 docs: add, refactor, and reformat discourse docs feat. charmcraft charmcraft merged Merged PR #2010 as commit a1a3d4b1, migrating Charmcraft content to RTD-ready docs, reformatting it, and separating Ops-related material.
70%
#143 New release (and improved howto). charmcraft merged Merged in charmcraft#143 (change d5570668, merge 90ae3562), releasing Charmcraft 0.4.0 and improving the release how-to documentation.
70%
#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.
70%