Skip to content

Add commas after e.g. because American English #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 22, 2021
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions building/markdown/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Existing descriptions and test-cases can be updated to adhere to them without re

### Consistency within an exercise

There are some terms that have multiple valid spellings (e.g. "lower case" vs "lowercase").
There are some terms that have multiple valid spellings (e.g., "lower case" vs "lowercase").
Where a consistent style has not been agreed within this document, these must be consistent within an exercise.

### Exceptions
Expand Down Expand Up @@ -66,7 +66,9 @@ Some abbreviations are considered common, useful, and non-technical enough that
- `etc.` or `etc`
- `docs`

Contractions (e.g. "won't", "I'm", "that's") should be used sparingly if at all in exercise descriptions, but are not restricted in other language around the site (e.g. website copy, mentoring).
Contractions (e.g., "won't", "I'm", "that's") should be used sparingly if at all in exercise descriptions, but are not restricted in other language around the site (e.g., website copy, mentoring).

The abbreviations "i.e." and "e.g." should be followed by a comma in American English (see, e.g., this [StackExchange thread](https://english.stackexchange.com/questions/7946/use-of-e-g-are-parentheses-necessary/93658#93658)).

## Choice of words

Expand Down