docs: Make US spelling the default again#800
Draft
izmalk wants to merge 3 commits intocanonical:2/edgefrom
Draft
docs: Make US spelling the default again#800izmalk wants to merge 3 commits intocanonical:2/edgefrom
izmalk wants to merge 3 commits intocanonical:2/edgefrom
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
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.
Description of issue or feature:
The Vale spell checker was using a dictionary from the Canonical documentation style guide that contained both US and UK English spellings (81,536 entries). This meant UK spelling variants like "colour", "centre", "organise", "analyse", and "behaviour" were not flagged as errors, leading to inconsistent American English usage in the documentation.
Solution:
Replaced the mixed-language dictionary with a US-only SCOWL-based Hunspell dictionary (49,569 entries, version 2020.12.07) from wordlist.sourceforge.net (source). The dictionary files are now stored directly in the repository at .sphinx/dictionaries/ and copied to the Vale configuration during make spelling.
Changes made:
Added US-only dictionary files to
.sphinx/dictionaries/(en_US.dic,en_US.aff)Updated Makefile vale-install target to copy local dictionary files instead of downloading
Added a comprehensive
README.mddocumenting the dictionary source, usage, and verificationUK spellings are now properly flagged as spelling errors, while US spellings are accepted.
How was this change tested?
Run
make spelling.Checklist