Skip to content

Support Spellchecking of Technical Writing #174

@gkapfham

Description

@gkapfham

Is your feature request related to a problem? Please describe.

The current version of GatorGrader does not have a way to perform spellchecking on the submitted technical writing. While it might be possible to leverage existing spellcheckers for different Unix-like platforms, it is probably a good idea to implement these checks in a platform independent fashion. If technical writing contains spelling mistakes that can be reliably detected, then this is a suitable circumstance in which we can fail a build.

Describe the solution you'd like

It should be possible to specify a file in a directory and then have a new option called --spellcheck, using the current approach to the command-line arguments. This would then trigger a reliable, Python-based spellchecker. Here is an example of a project to consider: https://pypi.org/project/pyspellchecker/.

Let me know what you think, @corlettim and @schultzh and @Michionlion. If you like this idea, then I can work with one of you to implement it or try to implement it on my own. With that said, I think that it might be advisable to wait to implement this until after we have introduced the linting interface.

Metadata

Metadata

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions