Closed ColonelPanics closed 1 year ago
Hello, thanks a lot, that's great!
I like how you split the change into three commits, however to rebase as is, I would like that you prefix the first and last one with the fix:
type, and the second one with the refactor:
type.
Otherwise if you're OK with squashing I can do that too.
Also don't worry about the CI failure, I'll take care of it, it's unrelated to your changes.
Thanks for the feedback @pawamoy! I've tweaked and force-pushed the message changes. Let me know if there's anything else you need from me.
Thanks for your useful plugin
Perfect, thanks!
I fixed the deprecation warning and released your change as part of v1.0.1 :slightly_smiling_face:
Overview
The current word separation in
mkdocs-spellcheck
causes words likeisn't
,wouldn't
etc to be split such that they are checked asisn
andwouldn
, leading to erroneous warnings about misspelling.This PR modifies the regex for separating out words. Previously this regex would only check letters and spaces, now it also removes:
\B
) preceding, following or surrounding a word (this means that single quotes can be used to surround a word without being retained for spellchecking)'s
), this means that the word preceding the's
will be checked against the dictionarySteps to Test
Tested with:
Steps:
mkdocs new mydocs
mkdocs.yml
in the new directory to look as follows:Set
docs/index.md
to contain the followingRun
mkdocs serve -s
and only an error forisn
should be returned (Note: I've left in these deprecation warnings as these may be something else that needs fixing)