Add a spellcheck CI job for markdown files #564
Conversation
markstur
left a comment
There was a problem hiding this comment.
I see a couple typos in your exceptions. Should fix those. I am in favor of a spellcheck even though sometimes it's a pain.
|
Thanks @markstur for the review - I addressed your comments and reduced the custom dictionary even more with a couple more spell fixes. It looks like both "pre-trained" and "pretrained" are acceptable, however the version with the hyphen seems more common, so I left it as it is. |
Indeed - I tried to configure the spellcheck to give as little pain as possible. Ultimately I think it's worth the little extra pain, rather than having spelling errors in the docs (which look rather unprofessional) and many small PRs fixing them. |
Spellcheck all markdown files (expect REVIEWERS) to help us maintain how quality docs. Code snippets are excluded from the check. The job only runs when markdown files are changed to save CI resources. Add a custom dictionary that includes words unknown by the default dict. Signed-off-by: Andrea Frittoli <[email protected]>
hickeyma
left a comment
There was a problem hiding this comment.
LGTM, thanks for this handy tool @afrittoli
Yeah a lot of one word /two words/hyphen decisions depend on before or after the noun. A pre-trained thing vs the thing is pretrained. I refer to grammarly (well basically I google is X one word or two or hyphenated) |
Description of your changes:
Spellcheck all markdown files (except REVIEWERS) to help us maintain how quality docs.
Code snippets are excluded from the check.
The job only runs when markdown files are changed to save CI resources.
Add a custom dictionary that includes words unknown by the default dict.