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 PR fixes a bunch of spelling and grammar issues that I found with LanguageTool using a semi-automated process that I will describe in detail below.
I have focused on issues that are obvious mistakes, rather than just poor style or against some convention. As such, this PR does not attempt to correct:
ise
/ize
word ending conventions.The workflow described below finds hundreds of these issues, which may or may not be worth resolving as well. Note that I have thus far only looked at documents from the
specification
root directory, theappendices
subdirectory, and the filemodules/end_to_end_encryption.rst
, as I unfortunately don't have more time to work on this for now.Workflow
Spell- and grammar-checking technical documents is challenging because symbols and jargon invariably generate an overwhelming number of false positives. The following setup works quite well for the Spec:
org/languagetool/resource/en/hunspell/ignore.txt
with the contents of that Gist. This dramatically reduces the number of false positives.pandoc -t plain PATH/TO/SPEC/DOCUMENT.rst | java -jar languagetool-commandline.jar -l en-GB -d 'WHITESPACE_RULE,DASH_RULE,EN_QUOTES,MULTIPLICATION_SIGN,WORD_CONTAINS_UNDERSCORE,ENGLISH_WORD_REPEAT_BEGINNING_RULE,COMMA_PARENTHESIS_WHITESPACE,SENTENCE_WHITESPACE,UPPERCASE_SENTENCE_START,PLUS_MINUS,ARROWS,OXFORD_SPELLING_ISE_VERBS,OXFORD_SPELLING_NOUNS,OXFORD_SPELLING_ADJECTIVES,LICENCE_LICENSE_NOUN_SINGULAR,AN_INVITE,UNLIKELY_OPENING_PUNCTUATION,EN_UNPAIRED_BRACKETS,ANYMORE'
.The raised issues are of fairly high quality, with roughly 30-40% of them being actual problems that warrant fixing.
Signed-off-by: Philipp Emanuel Weidmann pew@worldwidemann.com