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
fb9865e7
Commit
fb9865e7
authored
Sep 29, 2020
by
Craig Norris
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Updated line spacing
parent
c8efe0e8
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
7 additions
and
7 deletions
+7
-7
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+7
-7
No files found.
doc/development/documentation/styleguide.md
View file @
fb9865e7
...
...
@@ -1467,18 +1467,18 @@ guidelines, but for consistency you should try to use these values:
### Note
Notes indicate additional information that is of special use to the reader.
Notes are most
effective when used _sparingly_.
Notes indicate additional information that is of special use to the reader.
Notes are most
effective when used _sparingly_.
Try to avoid them. Too many notes can impact the scannability of a topic and create an overly busy page.
Try to avoid them. Too many notes can impact the scannability of a topic and
create an overly busy page.
Instead of adding a note, try one of these alternatives:
-
Re-write the sentence as part of the most-relevant
paragraph.
-
Re-write the sentence as part of the most-relevant paragraph.
-
Put the information into its own standalone paragraph.
-
Put the content under a new subheading that introduces the topic, which makes
it more
visible.
-
Put the content under a new subheading that introduces the topic, which makes
it more
visible.
If you must use a note, use the following formatting:
...
...
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