New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create spellcheck.yml #92
Conversation
Run spellcheck on the entire repository using @check-spelling/check-spelling@v0.0.19
Codecov Report
@@ Coverage Diff @@
## master #92 +/- ##
=======================================
Coverage 90.15% 90.15%
=======================================
Files 9 9
Lines 508 508
=======================================
Hits 458 458
Misses 50 50
Continue to review full report at Codecov.
|
spellcheck.yml updated to match standard template for @check-spelling/check-spelling
@Quantalabs indeed, we have ourselves quite a problem here: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have a long way to go... 🚀
This commit adds a list of commonly used words in the repository to be included in the dictionary for @check-spelling/check-spelling. The list is limited to real words that would be used in a Markdown document (other words will have to be dealt with differently). Changelist: Add list of allowed words: allow.txt to .github/actions/spelling Additional Notes: Recommendation (trivial): Adding the allow.txt document to your local code editor's spell-checking system is recommended so that your local setup is in sync with the repo setup. That way, you won't be surprised when submitting PRs and such things.
.github/actions/spelling configuration was added for the @check-spelling/check-spelling action. Changelist: - .github/actions/spelling - Add allow.txt with new allowed words - Add excludes.txt to exclude files based on common glob patterns - Add patterns.txt to ignore URLs, paths, configs, etc. Additional Notes: Spelling (minor): An additional expect.txt file will have to be added in order to accommodate incorrect words found in files or comments will have to be added to those lines.
f079b38
to
fd01c8f
Compare
Fixes: fd01c8f
`^\.github/action/spelling/` has been changed to: `^\.github/actions/spelling/` in .github/actions/spelling/excludes.txt
Fix all spelling errors and configuration, once and for all. Changelist: - .github/actions/spelling - Add `setuptools` to allow.txt - Exclude JPEG, CSV files, .gitignore, and binaries in excludes.txt - Create expects.txt - Ignore URLs and lines with `# spellcheck: disable` comments in patterns.txt - Add `# spellcheck: disable` comments to remaining spellcheck errors
- Add `sdist` to expect.txt and reorder alphabetically - Disable spellchecking on README URLs
These are the spelling errors that @check-spelling/check-spelling doesn't warn about. Changelist: - .github/actions/spelling - Add `GPLv` to allow.txt - Add new words to expect.txt - Add ignore comments in README.md, epispot/plots/native.py, workflows/codeql-analysis.yml
00a8e96
to
7adfcc8
Compare
Done! 🎉 |
Run spellcheck on the entire repository using @check-spelling/check-spelling@v0.0.19.