Skip to content

Commit 6691cdf

Browse files
committed
Updates and fixes after cherry-pick
1 parent b7861f4 commit 6691cdf

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/style-guide/style-conventions.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ We prioritize simplicity over comprehensiveness. If you can't find a particular
9696

9797
## Sentences and paragraphs
9898

99-
- Write sentences of a maximum of 25 words and paragraphs of 5 lines. Rewrite the content and break sentences and paragraphs as necessary.
99+
- Write sentences of a maximum of 25 words and paragraphs of 5 lines or less. Rewrite the content and break sentences and paragraphs as necessary.
100100
- Include *the* and *that* to clarify your sentence.
101101

102102
| Usage | Example |
@@ -134,7 +134,7 @@ We prioritize simplicity over comprehensiveness. If you can't find a particular
134134
- Use these guidelines for periods:
135135
- Use a period at the end of a sentence, including sentences ending on a [URL](#links).
136136
- Observe the punctuation rules for items on a [bullet list](#bullet-lists).
137-
- Don't use semicolons (;). Instead, use a period (.) and write the text after the semicolon in a new sentence.
137+
- Don't use semicolons. Instead, use a period and write the text after the semicolon in a new sentence.
138138
- Don't use dashes (_em_ or _en_ dashes.) Instead, use parenthesis if you need to clarify information.
139139
- Use parenthesis sparingly, and don't write essential information inside parenthesis.
140140
- Don't use bold or italics with punctuation symbols.
@@ -317,8 +317,8 @@ Use links to other articles in the Status documentation, but don't abuse links.
317317

318318
| Usage | Example |
319319
|:------------|:-----------------------------------------------------------------|
320-
| **Correct** | To publish your token, click **Publish**. |
321-
| Incorrect | To publish your token, click the **Publish** button. |
320+
| **Correct** | To publish your token, click **Publish**. |
321+
| Incorrect | To publish your token, click the **Publish** button. |
322322
| **Correct** | On the **Permission** pop-up menu, tap the **Write** permission. |
323323
| Incorrect | On the **Permissions** pop-up, tap the **Write** permission. |
324324
| Incorrect | On **Permissions**, tap the **Write** permission. |
@@ -332,8 +332,8 @@ Use links to other articles in the Status documentation, but don't abuse links.
332332

333333
- Use *area* to describe a particular group of elements on the current screen.
334334

335-
| Usage | Example |
336-
|:------------|:-------------------------------------------------------------------------|
335+
| Usage | Example |
336+
|:------------|:------------------------------------------------------------------------|
337337
| **Correct** | On the **Contacts** screen, click **All** under the **Filter** area. |
338338
| Incorrect | On the **Contacts** screen, click **All** under the **Filter** section. |
339339

@@ -362,7 +362,7 @@ Use links to other articles in the Status documentation, but don't abuse links.
362362

363363
| Admonition | Description |
364364
|:---|:---|
365-
| Tip | Information that is not necessary for the task, but it's helpful and nice to have. For example, information about a keyboard shortcut. |
365+
| Tip | Information that is not necessary for the task, but it's helpful or nice to have. For example, information about a keyboard shortcut. |
366366
| Info | Information that is relevant to complete the task, but has no impact on the user's actions. |
367367
| Caution | Information that has an impact on the user's actions. Based on this information, the user may decide to complete or don't complete the task. |
368368

@@ -486,21 +486,21 @@ Modal verbs are auxiliary verbs that modify the meaning of the main verb in a se
486486
487487
- Keep phrasal verbs together.
488488
489-
| Usage | Example |
490-
|:----------|:-------------------------------------------------------------|
491-
| **Correct** | Execute the command `shutdown -h now` to shut down the server. |
492-
| Incorrect | Execute the command `shutdown -h now` to shut the server down. |
489+
| Usage | Example |
490+
|:------------|:---------------------------------------------------------------|
491+
| **Correct** | Execute the command `shutdown -h now` to shut down the server. |
492+
| Incorrect | Execute the command `shutdown -h now` to shut the server down. |
493493
494494
- Avoid referring to the document itself using *On this procedure*, *In this document*, *In the following list*, *In this section*, or similar expressions. Use *here* instead.
495495
496-
| Usage | Example |
497-
|:----------|:-----------------------------------------------------------------------|
498-
| **Correct** | Here you can find the list of keyboard shortcuts. |
499-
| Incorrect | In the following section, you can find the list of keyboard shortcuts. |
496+
| Usage | Example |
497+
|:------------|:-----------------------------------------------------------------------|
498+
| **Correct** | Here you can find the list of keyboard shortcuts. |
499+
| Incorrect | In the following section, you can find the list of keyboard shortcuts. |
500500
501501
## Common words usage
502502
503-
- For spelling differences between different English dialects, adhere to the most widely used dialect.
503+
- For spelling differences among English dialects, adhere to the most widely used dialect.
504504
- Don't use Latin abbreviations like *e.g.*, *etc.* or *i.e.* Use an English equivalent, like *for example*, *and so on*, or *that is*.
505505
- This list summarizes some common words and terms:
506506

0 commit comments

Comments
 (0)