Skip to content

Commit f56ecef

Browse files
committed
added examples for Capitalization
1 parent 95ebab8 commit f56ecef

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

docs/DocumentationStyleGuide/language-grammar/capitalization.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,25 @@ The guidelines in this case are:
2121
- Headline style capitalization should be employed as per the context,
2222
like blog posts, research paper titles to use initial uppercase
2323
letters for all significant words in the text.
24+
- More detailed explanation on sentence case:
25+
In sentence case, lowercase most words in a title or heading. Capitalize only the following words:
26+
- The first word of the title or heading
27+
- The first word of a subtitle
28+
- The first word after a colon, em dash, or end punctuation in a heading
29+
- Nouns followed by numerals or letters
30+
- Proper nouns (such as the names of racial or ethnic groups)
31+
32+
+-------------------------------------+--------------------------------------------+
33+
| Recommended examples | Not recommended examples |
34+
+=====================================+============================================+
35+
| Contents: | contents: |
36+
| Setup Git | setup git |
37+
| Install and Configure Git | Install and Configure Git |
38+
+-------------------------------------+--------------------------------------------+
39+
| # Github Workflow | # github workflow |
40+
| example of headline style | proper headline style capitalization |
41+
| capitalization. | is a must, modify depending to context. |
42+
+-------------------------------------+--------------------------------------------+
43+
| Issue raised based on FLINT | issue raised based on FLINT Documentation: |
44+
| documentation : Self-reported issue | seld-reported issue |
45+
+-------------------------------------+--------------------------------------------+

0 commit comments

Comments
 (0)