docs: fix spelling errors and Vale linting failures
Metadata
Current evaluation
Merged PR #2966 to fix documentation spelling errors and Vale linting failures in charmcraft, correcting typos in howto guides and updating `.custom_wordlist.txt`.
Resolution: closed resolved
Reason: The pull request was merged, resolving documentation linting and spelling issues. It corrects typos in `howto/` guides, updates the custom wordlist, and fixes code-block directives.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Fix documentation spelling errors and Vale linting failures:
- Add `lockfile` and `pytest` to `.custom_wordlist.txt`.
- Fix typos (`publisht` -> `publish`, `toincrement` -> `to increment`, `sureto` -> `sure to`) in `howto/manage-libraries.rst`.
- Replace `lintings` with `lint checks` in `howto/manage-charms.rst`.
- Use `.. code-block:: bash` in `howto/shared-cache.rst` so `mkdir` is treated as code.
- Ignore specific colloquial/informal terms with `:vale-ignore:` (`hacky` in `howto/manage-tracks.rst`, `libs` heading in `howto/manage-charms.rst`).
Verified with `make docs-lint`, `make lint`, and `make test-fast`.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | closed resolved | Merged PR #2966 to fix documentation spelling errors and Vale linting failures in charmcraft, correcting typos in howto guides and updating `.custom_wordlist.txt`. |
Update history
| Date | Change |
|---|---|
| merged | |
| updated | |
| created |
Related work
-
Related To:
canonical/charmcraft#2930
(confidence 90%)
PR #2966 was created to fix linting issues introduced in #2930.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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). | |
| #445 docs: resolve Vale spellcheck errors from vale 3.22 | craft-store | merged | Merged into main to resolve Vale 3.22.0 spellcheck failures in docs by replacing "PRs" with "pull requests" and adding "venv" and "mv" to the custom wordlist. | |
| #2154 docs: replace occurrences of "charmcraft.yaml" and "recipe" | charmcraft | merged | Merged PR #2154 (a6ccb3d4) updated 23 documentation files to use “project” or “project file” instead of “charmcraft.yaml” and “recipe.” | |
| #2186 docs: fix build errors | charmcraft | merged | Merged as charmcraft/charmcraft#2186 in commit 42f42bd2, fixing the targeted docs build error. Remaining transclusion problems were addressed separately in canonical/craft-parts#1021. | |
| #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. | |
| #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. | |
| #205 docs: reword "PRs" to "pull requests" for Vale spellcheck | debcraft | merged | Merged PR #205 to fix Vale spellcheck failure by rewording "PRs" to "pull requests" in docs/explanation/documentation.rst. |