Spell checking #431
Merged
Spell checking #431
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
This commit adds spell checking to all the other prose and
markdown checks currently in place.
As spell checking is a pretty pedantic issue, often marking
jargon (like 501c3, BDFL, or grantmaking) and project and
product names (like Homebrew, Kubernetes, or WordPress),
a personal `dictionary.txt` is included in `test/` with
exceptions for the articles.
URLs, filepaths, @mentions, emoji, and text in block quotes
(as those are used for quotes in the articles) are excluded
from the spell checking.
The spell checking highlighted some cases that I changed:
* All alt text of images is now properly cases if they
start the paragraph
* Typo `sizeable` > `sizable` (former is GB English, latter is
US English)
* Casing of `reddit` > `Reddit` (latter seems to be used more)
* Casing of `pypa` > `PyPA` (latter seems to be used more)
* Casing of `eslint` > `ESLint` (latter is the official casing)
* Casing of `READMES` > `READMEs` (plural `s` is now cased just
like `PRs` and `APIs`)
* Casing of `ok` > `OK` (latter is the propper spelling)
* Spelling of `PostgreSQL` > `Postgres` (both were used throughout,
the latter seems simpler and is just as well known)
* Hyphen in `tradeoffs` > `trade-offs` (both could probably be used,
but the latter is more often used)
* Latin `de minimis` > `minimal` (this section is about law, so the
Latin makes sense, but it’s also a phrase I had to look up, so
I’m guessing other people would have to as well)
* Space in `pageviews` > `page views` (former is more about the
metrics in Google Analytics I believe, latter is just as good?)
* Space in `datasets` > `data sets` (both work, but latter is more
common?)
|
Ohh thanks for the kind words @nayafia! Yeah, seems html-proofer couldn’t reach http://sarah.thesharps.us/2015/10/06/what-makes-a-good-community for some reason, but it looks up, so 🤷♂️ 👋 |
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.
Hi folks! 👋
A while ago I promised to add spell checking to the articles. Well, I finally did. Oops 😬
The spell checking is the most important part. Check out
57d8576for more info: it includes a commit message detailing all the proposed changes.Before beginning work on spell checking, I also updates all the other prose checks. Some APIs changed, mostly regarding
[email protected]and[email protected]. Those pages have quite some info already, but let me know if there are questions!