Skip to content
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

Add abbreviations and restructure slightly #1718

Merged
merged 5 commits into from
Oct 19, 2020
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
10 changes: 10 additions & 0 deletions STYLE-GUIDE.md
Original file line number Diff line number Diff line change
@@ -47,6 +47,16 @@ An some examples of good usage:
- "NASA, the United States' space agency, launched the Mariner 2 space probe in..." _(NASA is not expanded because the "National Aerospace and Space Administration" is much better known by its acronym than by its expanded name)_
- "The Department of Motor Vehicles (DMV) is filled with sloths. That's why everything takes forever at the DMV" _(Define DMV the first time it is used)_
iHiD marked this conversation as resolved.
Show resolved Hide resolved

iHiD marked this conversation as resolved.
Show resolved Hide resolved
#### Exceptions

Some abbreviations are considered common, useful, and non-technical enough that we have decided to permit them:
- `e.g.` or `eg`
- `i.e.` or `ie`
- `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).
Copy link
Contributor

@SaschaMann SaschaMann Oct 19, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't this belong in "Choice of words"? (don't consider this blocking)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe, but as the discussion came up here I figured it might fit. As we flesh this whole thing out more we'll probably find a better structure in general.


## Choice of words

### Mathematical and jargon terms.