iSharkFly-Docs
/
opensearch-docs-cn
mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Adjusts list (#2622) 

Signed-off-by: natebower <102320899+natebower@users.noreply.github.com>
This commit is contained in:
Nathan Bower 2023-02-03 11:59:52 -05:00 committed by GitHub
parent 184ddbe122
commit 6b809f289c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
STYLE_GUIDE.md
View File

@ -183,17 +183,17 @@ The following table lists acronyms that you don't need to spell out.
### Lists ### Lists
The following guidelines apply to all list types: The following guidelines apply to all list types:
- Make lists parallel in content and structure. Don’t mix single words with phrases, don’t start some phrases with a noun and others with a verb, and don’t mix verb forms. - Make lists parallel in content and structure. Don’t mix single words with phrases, don’t start some phrases with a noun and others with a verb, and don’t mix verb forms.
- Present the items in alphabetical order if the order of items is arbitrary. - Present the items in alphabetical order if the order of items is arbitrary.
- Capitalize the first letter of the first word of each list item. - Capitalize the first letter of the first word of each list item.
- If the list is simple, you don’t need end punctuation for the list items. - If the list is simple, you don’t need end punctuation for the list items.
- If the list has a mixture of phrases and sentences, punctuate each list item. - If the list has a mixture of phrases and sentences, punctuate each list item.
- Punctuate each list item with a period if a list item has more than one sentence. - Punctuate each list item with a period if a list item has more than one sentence.
- Punctuate list items consistently. If at least one item in a list requires a period, use a period for all items in that list. - Punctuate list items consistently. If at least one item in a list requires a period, use a period for all items in that list.
- Introductory sentences are required for lists. - Introductory sentences are required for lists.
- Introductory sentences should be complete sentences. - Introductory sentences should be complete sentences.
- Introductory sentences should end with a colon. - Introductory sentences should end with a colon.
- Don’t use semicolons, commas, or conjunctions (like and or or) at the end of list items. - Don’t use semicolons, commas, or conjunctions (like and or or) at the end of list items.
### Numbers and measurement ### Numbers and measurement