WIP: Add spellchecking feature #233
Open
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
…unction in invoke.py.
…e in gator folder.
Jordan-A
added
feature
tests
on-hold
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.
This pull request is for implementing spellchecking in Gator Grader.
What is the current behavior?
This pull request is associated with issue #174. Currently there's no option for spellchecking in GatorGrader. This means that the tool does not ensure that reports are spelled correctly, or are even comprised of real words ie: garbage words. Therefore implementing a spellchecking feature would help ensure that reports are written correctly.
What is the new behavior if this PR is merged?
If merged there will be the option to use spellchecking as a GatorGrader check to ensure all writing (Outside of code blocks, segments, links, etc) in a markdown file is spelled correctly.
Other information
Currently spellchecking is functional but it does not correctly format markdown files for code blocks, code segments, links, etc. As of now there's no complete test files to ensure the spellcheck files are working as intended. Spell checking has been implemented using a tool called symspellpy. I have done some manual testing for detecting garbage words and I have found that it has been effective at detecting them.
This PR has:
This PR is a feature that fixes #174.
Developers
@Jordan-A
@schultzh