Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
a9a63d71
Commit
a9a63d71
authored
Sep 08, 2020
by
Craig Norris
Committed by
Suzanne Selhorn
Sep 08, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Docs: Update Style Guide with minor contraction recommendations
parent
1dd797d7
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
18 additions
and
17 deletions
+18
-17
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+18
-17
No files found.
doc/development/documentation/styleguide.md
View file @
a9a63d71
...
...
@@ -540,36 +540,37 @@ tenses, words, and phrases:
### Contractions
Contractions can create a friendly and informal tone, especially in tutorials, instructional
documentation, and
[
user interfaces
](
https://design.gitlab.com/content/punctuation/#contractions
)
.
Contractions are encouraged, and can create a friendly and informal tone,
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
| Don't
|
|----------------------
|
---------------------|
| GitLab is creating X
| GitLab's creating X
|
| Do
| Don't
|
|----------------------
--------------------|--------------------
---------------------|
| GitLab is creating X
. | GitLab's creating X.
|
-
Do not use contractions when you need to emphasize a negative. For example:
| Do
| Don't
|
|-----------------------------
|
----------------------------|
| Do
*
*not**
install X with Y |
**Don't**
install X with Y
|
| Do
| Don't
|
|-----------------------------
-------------|-------------
----------------------------|
| Do
*
not*
install X with Y. |
*Don't*
install X with Y.
|
-
Do not use contractions in reference documentation. For example:
| Do | Don't |
|------------------------------------------|----------------------------------------|
| 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
|
| Do | Don't
|
|------------------------------------------|----------------------------------------
-
|
| 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.
|
-
Avoid contractions in error messages. Examples:
| Do | Don't |
|------------------------------------------|--------------------------------------|
| Requests to localhost are not allowed
| Requests to localhost aren't allowed
|
| Specified URL cannot be used
| Specified URL can't be used
|
| Do | Don't
|
|------------------------------------------|--------------------------------------
---
|
| Requests to localhost are not allowed
. | Requests to localhost aren't allowed.
|
| Specified URL cannot be used
. | Specified URL can't be used.
|
## Text
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment