close
Skip to content

ci: update spelling#2167

Merged
tonyandrewmeyer merged 6 commits intocanonical:mainfrom
tonyandrewmeyer:update-spelling-list
Nov 16, 2025
Merged

ci: update spelling#2167
tonyandrewmeyer merged 6 commits intocanonical:mainfrom
tonyandrewmeyer:update-spelling-list

Conversation

@tonyandrewmeyer
Copy link
Copy Markdown
Collaborator

@tonyandrewmeyer tonyandrewmeyer commented Nov 13, 2025

The docs spellcheck seems to have updated underneath us, so make adjustments so that the checks pass again.

For the most part, I've added words to the custom word list, but I've made a few adjustments to the docs in cases where it seemed better than adding the word.

The PR also corrects the description of Scenario's behaviour when creating a temporary charm root: only the metadata files are written - the src and lib folders are not also copied there.

(See also canonical/jubilant#225)

Comment thread docs/explanation/tracing.md
Comment thread docs/explanation/state-transition-testing.md Outdated
@benhoyt
Copy link
Copy Markdown
Collaborator

benhoyt commented Nov 13, 2025

Ah, thanks for this. Yeah, I noticed this over in Jubilant-land too. It's another thing that makes me wonder about the worthwhileness of spelling checks. But we can get David's opinion on all that when he's back.

Comment thread testing/src/scenario/context.py Outdated
Comment thread docs/.custom_wordlist.txt Outdated
Comment thread docs/explanation/state-transition-testing.md Outdated
@tonyandrewmeyer tonyandrewmeyer merged commit 67249f0 into canonical:main Nov 16, 2025
56 checks passed
@tonyandrewmeyer tonyandrewmeyer deleted the update-spelling-list branch November 16, 2025 19:17
@dwilding
Copy link
Copy Markdown
Contributor

Thanks for doing this @tonyandrewmeyer. The extra spelling exceptions were needed because the spelling check previously wasn't checking all text. I was tracking the fix in canonical/documentation-style-guide#138 (sorry, I think I forgot to mention that in my notes before I went away).

I don't expect major changes to the spelling setup from now on, now that (as far as I could test previously) it's checking everything that it should be checking.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants