pawamoy / mkdocs-spellcheck

A spell checker plugin for MkDocs.
https://pawamoy.github.io/mkdocs-spellcheck/
ISC License
16 stars 4 forks source link

Handle Single Quotes Properly #16

Closed ColonelPanicks closed 1 year ago

ColonelPanicks commented 1 year ago

Overview

The current word separation in mkdocs-spellcheck causes words like isn't, wouldn't etc to be split such that they are checked as isn and wouldn, 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:

Steps to Test

Tested with:

Steps:

pawamoy commented 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.

pawamoy commented 1 year ago

Also don't worry about the CI failure, I'll take care of it, it's unrelated to your changes.

ColonelPanicks commented 1 year ago

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

pawamoy commented 1 year ago

Perfect, thanks!

pawamoy commented 1 year ago

I fixed the deprecation warning and released your change as part of v1.0.1 :slightly_smiling_face: