Skip to content

Commit 363b1a0

Browse files
authored
Add weight, rename folder
1 parent 6d58fe1 commit 363b1a0

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/style-guide/punctuation.md renamed to docs/styleguide/punctuation.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
22
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
45
---
56

67
# Punctuation
78

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.
910

1011
## 1. Period (.)
1112

@@ -25,7 +26,7 @@ Note: The **Oxford comma** is the optional comma before the conjunction in a lis
2526

2627
## 3. Semi-colon (;)
2728

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.
2930
Some examples include:
3031
- "She finished her work; then she went home."
3132
- "I need to buy groceries; I'm running out of food."
@@ -39,12 +40,12 @@ Some examples include:
3940

4041
## 5. Dash (— or -)
4142

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.
4344
Some examples include:
4445
- "She went to the store—despite the rain—to buy some groceries."
4546
- "She received an unexpected gift—a brand new car!"
4647

47-
A **hyphen** (-) is used to join compound words or prefixes.
48+
A **hyphen** (-) joins compound words or prefixes.
4849
Example:
4950
- "The well-known actor starred in the movie."
5051

@@ -74,4 +75,4 @@ Some examples include:
7475
Use an Ellipsis to indicate the omission of words or a pause in speech.
7576
Some examples include:
7677
- "I can't believe you..."
77-
- "The best is yet to come..."
78+
- "The best is yet to come..."

0 commit comments

Comments
 (0)