Skip to content

G
gitlab-ce
Commit a9a63d71 authored by Craig Norris's avatar Craig Norris Committed by Suzanne Selhorn
Browse files
Options

Docs: Update Style Guide with minor contraction recommendations

parent 1dd797d7
Hide whitespace changes
Inline Side-by-side
Showing with 18 additions and 17 deletions
doc/development/documentation/styleguide.md
View file @ a9a63d71
...@@ -540,36 +540,37 @@ tenses, words, and phrases: ...@@ -540,36 +540,37 @@ tenses, words, and phrases:
### Contractions ### Contractions
Contractions can create a friendly and informal tone, especially in tutorials, instructional Contractions are encouraged, and can create a friendly and informal tone,
documentation, and [user interfaces](https://design.gitlab.com/content/punctuation/#contractions). especially in tutorials, instructional documentation, and
[user interfaces](https://design.gitlab.com/content/punctuation/#contractions).
Some contractions should be avoided: Some contractions, however, should be avoided:
- Do not use contractions with a proper noun and a verb. For example: - Do not use contractions with a proper noun and a verb. For example:
| Do | Don't | | Do | Don't |
|----------------------|---------------------| |------------------------------------------|-----------------------------------------|
| GitLab is creating X | GitLab's creating X | | GitLab is creating X. | GitLab's creating X. |
- Do not use contractions when you need to emphasize a negative. For example: - Do not use contractions when you need to emphasize a negative. For example:
| Do | Don't | | Do | Don't |
|-----------------------------|----------------------------| |------------------------------------------|-----------------------------------------|
| Do **not** install X with Y | **Don't** install X with Y | | Do *not* install X with Y. | *Don't* install X with Y. |
- Do not use contractions in reference documentation. For example: - Do not use contractions in reference documentation. For example:
| Do | Don't | | Do | Don't |
|------------------------------------------|----------------------------------------| |------------------------------------------|-----------------------------------------|
| Do **not** set a limit greater than 1000 | **Don't** set a limit greater than 1000 | | Do *not* set a limit greater than 1000. | *Don't* set a limit greater than 1000. |
| For `parameter1`, the default is 10 | For `parameter1`, the default's 10 | | For `parameter1`, the default is 10. | For `parameter1`, the default's 10. |
- Avoid contractions in error messages. Examples: - Avoid contractions in error messages. Examples:
| Do | Don't | | Do | Don't |
|------------------------------------------|--------------------------------------| |------------------------------------------|-----------------------------------------|
| Requests to localhost are not allowed | Requests to localhost aren't allowed | | Requests to localhost are not allowed. | Requests to localhost aren't allowed. |
| Specified URL cannot be used | Specified URL can't be used | | Specified URL cannot be used. | Specified URL can't be used. |
## Text ## Text
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7