You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/styleguide/punctuation.md
+7-6
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,12 @@
1
1
---
2
2
title: Punctuation style guide
3
-
Description: This style guide outlines the guideline for using punctuation in the documentation.
3
+
description: The style guide outlines the guidelines for using punctuation in the documentation.
4
+
weight: 100
4
5
---
5
6
6
7
# Punctuation
7
8
8
-
Writing documentation is important because it allows us to indirectly communicate with many people around the world. Punctuation is a crucial part of writing because it helps us to make our message clear and consistent. To make sure our documents follow the same standards and are consistent with others in the industry, it's important to use the style guides that have already been recognised.
9
+
Writing documentation is important because it allows us to communicate indirectly with many people around the world. Punctuation is a crucial part of writing because it helps us make our message clear and consistent. To ensure our documents follow the same standards and are consistent with others in the industry, it's important to use the style guides that have already been recognised.
9
10
10
11
## 1. Period (.)
11
12
@@ -25,7 +26,7 @@ Note: The **Oxford comma** is the optional comma before the conjunction in a lis
25
26
26
27
## 3. Semi-colon (;)
27
28
28
-
Use a semi-colon to separate two independent clauses that are closely related but could be separate sentences.
29
+
Use a semicolon to separate two independent clauses that are closely related but could be separate sentences.
29
30
Some examples include:
30
31
- "She finished her work; then she went home."
31
32
- "I need to buy groceries; I'm running out of food."
@@ -39,12 +40,12 @@ Some examples include:
39
40
40
41
## 5. Dash (— or -)
41
42
42
-
An em Dash (—) is used to indicate a sudden break or interruption in a sentence or to provide emphasis.
43
+
An em Dash (—) indicates a sudden break or interruption in a sentence or provides emphasis.
43
44
Some examples include:
44
45
- "She went to the store—despite the rain—to buy some groceries."
45
46
- "She received an unexpected gift—a brand new car!"
46
47
47
-
A **hyphen** (-) is used to join compound words or prefixes.
48
+
A **hyphen** (-) joins compound words or prefixes.
48
49
Example:
49
50
- "The well-known actor starred in the movie."
50
51
@@ -74,4 +75,4 @@ Some examples include:
74
75
Use an Ellipsis to indicate the omission of words or a pause in speech.
0 commit comments