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
c0570c99
Commit
c0570c99
authored
Nov 01, 2021
by
Suzanne Selhorn
Committed by
Diana Logan
Nov 01, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Removed italics because our guidance says not to use
parent
175d0cc9
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
5 additions
and
5 deletions
+5
-5
doc/development/documentation/styleguide/index.md
doc/development/documentation/styleguide/index.md
+5
-5
No files found.
doc/development/documentation/styleguide/index.md
View file @
c0570c99
...
@@ -317,8 +317,8 @@ create an issue or an MR to propose a change to the user interface text.
...
@@ -317,8 +317,8 @@ create an issue or an MR to propose a change to the user interface text.
#### Feature names
#### Feature names
-
*Feature names are typically lowercase*
.
-
Feature names are typically lowercase
.
-
*Some features are capitalized*
, typically nouns naming
GitLab-specific
-
Some features are capitalized, typically nouns that name
GitLab-specific
capabilities or tools.
capabilities or tools.
See the
[
word list
](
word_list.md
)
for details.
See the
[
word list
](
word_list.md
)
for details.
...
@@ -404,13 +404,13 @@ Some contractions, however, should be avoided:
...
@@ -404,13 +404,13 @@ Some contractions, however, should be avoided:
| 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:
...
@@ -701,7 +701,7 @@ that's best described by a matrix, tables are the best choice.
...
@@ -701,7 +701,7 @@ that's best described by a matrix, tables are the best choice.
To keep tables accessible and scannable, tables should not have any
To keep tables accessible and scannable, tables should not have any
empty cells. If there is no otherwise meaningful value for a cell, consider entering
empty cells. If there is no otherwise meaningful value for a cell, consider entering
*
N/A*
(for 'not applicable') or
*none
*
.
*
*N/A**
for 'not applicable' or
**None*
*
.
To help tables be easier to maintain, consider adding additional spaces to the
To help tables be easier to maintain, consider adding additional spaces to the
column widths to make them consistent. For example:
column widths to make them consistent. For example:
...
...
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