Skip to content

G
gitlab-ce
Commit bcab3022 authored by Mike Jang's avatar Mike Jang
Browse files
Options

Merge branch 'eread/fix-table-indenting' into 'master' 

Indent tables to align with list

See merge request gitlab-org/gitlab!33009
parents 8e7b434e 372c7b2d
Show whitespace changes
Inline Side-by-side
Showing with 32 additions and 32 deletions
doc/development/documentation/styleguide.md
View file @ bcab3022
...@@ -333,53 +333,53 @@ tenses, words, and phrases: ...@@ -333,53 +333,53 @@ tenses, words, and phrases:
- Use common contractions when it helps create a friendly and informal tone, especially in tutorials, instructional documentation, and [UIs](https://design.gitlab.com/content/punctuation/#contractions). - Use common contractions when it helps create a friendly and informal tone, especially in tutorials, instructional documentation, and [UIs](https://design.gitlab.com/content/punctuation/#contractions).
| Do | Don't | | Do | Don't |
|----------|-----------| |----------|-----------|
| it's | it is | | it's | it is |
| can't | cannot | | can't | cannot |
| wouldn't | would not | | wouldn't | would not |
| you're | you are | | you're | you are |
| you've | you have | | you've | you have |
| haven't | have not | | haven't | have not |
| don't | do not | | don't | do not |
| we're | we are | | we're | we are |
| that's | that is | | that's | that is |
| won't | will not | | won't | will not |
- Avoid less common contractions: - Avoid less common contractions:
| Do | Don't | | Do | Don't |
|--------------|-------------| |--------------|-------------|
| he would | he'd | | he would | he'd |
| it will | it'll | | it will | it'll |
| should have | should've | | should have | should've |
| there would | there'd | | there would | there'd |
- 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 |
<!-- vale on --> <!-- vale on -->
......
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