Add spell checking for Markdown files to CircleCI via GNU Aspell. #1081
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
jbampton
requested review from
alexcjohnson and
Marc-Andre-Rivet
as code owners
jbampton
force-pushed
the
spell-check
branch
2 times, most recently
from
428696d to
3ac5725
Compare
jbampton
changed the title
|
Hey @chriddyp and @nicolaskruchten how about some spell checking 👍 |
jbampton
force-pushed
the
spell-check
branch
8 times, most recently
from
baf5547 to
c3fbd91
Compare
jbampton
changed the title
jbampton
force-pushed
the
spell-check
branch
6 times, most recently
from
28d81c6 to
e7a8669
Compare
|
Hey @Marc-Andre-Rivet updated and ready for review 👍 |
jbampton
force-pushed
the
spell-check
branch
2 times, most recently
from
f69b5d2 to
17ea864
Compare
Install aspell on CircleCI. Add a custom dictionary file. Spell check the Markdown files with a shell script. Add section on spell checking to the contributing guide. Update the CHANGELOG.
|
@jbampton thanks for the contribution, but we've decided this is a heavier approach than we really want - we'll continue just spell checking via manual PR reviews. |
jbampton
added a commit
to jbampton/plotly.js
that referenced
this pull request
Dec 21, 2020
Found a better way to check spelling. This Go tool does find mistakes in source code as well as Markdown. From my experience it does not work on all file types or find all the errors, but it does seem to work well on code comments - refs plotly#5349 - refs plotly/dash#1081 Using -> https://github.com/client9/misspell
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Install aspell on CircleCI. Add a custom dictionary file.
Spell check the Markdown files with a shell script.
Add section on spell checking to the contributing guide.
Update the CHANGELOG.
http://aspell.net/
https://en.wikipedia.org/wiki/GNU_Aspell