Add spell checker to alleviate spelling errors #32
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hickeyma
requested review from
andrea-fasoli,
chichun-charlie-liu,
kcirred,
nwang-ibm and
tharapalanivel
as code owners
This adds the pyspelling spell check automation tool. It is a wrapper around CLI of Aspell or Hunspell which are spell checker tools. The PR specifies that pyspelling uses Aspell as the spell checker tools can differ in output. Therefore by speficying Aspell, it will mean consistency. Closes foundation-model-stack#31 Signed-off-by: Martin Hickey <[email protected]>
hickeyma
force-pushed
the
ci/add-spell-check
branch
from
1e71b1b to
81ff41f
Compare
Add sub-section about spell checker. Signed-off-by: Martin Hickey <[email protected]>
hickeyma
force-pushed
the
ci/add-spell-check
branch
from
7762870 to
2bd84b0
Compare
tharapalanivel
approved these changes
Dec 16, 2024
Collaborator
tharapalanivel
left a comment
tharapalanivel
left a comment
There was a problem hiding this comment.
LGTM, thanks Martin!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of the change
This adds the pyspelling spell check automation tool. It is a wrapper around CLI of Aspell and Hunspell which are spell checker tools. The PR specifies that pyspelling uses Aspell as the spell checker tools can differ in output. Therefore by speficying Aspell, it will mean consistency.
Related issue number
Closes #31
How to verify the PR
The spell checker can be run as follows:
tox -e spellcheckWas the PR tested