Spelling fixes#591
Open
jans23 wants to merge 3 commits into
Open
Conversation
These two new Makefile targets allow you to: - identify potential misspellings with sphinxcontrib-spelling[1] - (optionally) add them to a custom word list, and - loop through all the misspelled files, opening them with your $EDITOR. Run `make check-spelling` (alias: `spell`) to start the process, followed by `make fix-spelling` (aliases: `fix` or `correct`). A list of _correct_ spellings (which will not be flagged by the Sphinx extension) is contained in `wordlist.txt`. The `check-spelling` target gives you the opportunity to update this word list if new (putative) misspellings are identified. The `fix-spelling` target works best with Vim/Neovim. It employs the `hlsearch` and quickfix features to make it easier to find and correct spelling mistakes in the individual source files. For other editors, the misspelled file and the list of misspellings identified by sphinxcontrib-spelling are simply passed as command-line arguments. [1]: https://sphinxcontrib-spelling.readthedocs.io
Uses the `make fix-spelling` target introduced by PR #572
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
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.
Continuation of #572