Add spellcheck for docs #272
Merged
Conversation
This file contains 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
davidfaulkner12
changed the title
|
An example of failing spellcheck: https://github.com/fennel-ai/client/actions/runs/5932533994/job/16086498008?pr=272 |
davidfaulkner12
force-pushed
the
davidwf/add-spellcheck-to-docs
branch
from
7c75073
to
454be13
Compare
|
This is awesome! |
aditya-nambiar
approved these changes
Aug 21, 2023
| strftime | ||
| struct | ||
| tiering | ||
| uid |
There was a problem hiding this comment.
Can we keep it sorted across cases ?
| repo | ||
| runtime | ||
| scalability | ||
| scalable |
There was a problem hiding this comment.
Can we add extractor, depends_on, version, inputs, ( all our sources maybe ? kinesis, bigquery etc )
There was a problem hiding this comment.
Most of those are already part of the dictionary -- I'm not quite sure why scalable and scalability aren't. It's just this text file (which doesn't even need to be sorted) so trivial to add things later.
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.
While I was blocked on onboarding I went through and did a quick spellcheck Github Action for our docs. There were quite a few random misspellings (as would inevitably happen without CI). Not a perfect solution, but at least our public docs won't have any more tipos like "Fennnel" :-)