From e17b20c9cf9aef731a2355807211a71d40e0637a Mon Sep 17 00:00:00 2001 From: Manoj Tummala Date: Fri, 1 Oct 2021 18:48:48 +0530 Subject: [PATCH 1/3] added examples for Capitalization Signed-off-by: Manoj Tummala --- .../language-grammar/capitalization.rst | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/DocumentationStyleGuide/language-grammar/capitalization.rst b/docs/DocumentationStyleGuide/language-grammar/capitalization.rst index a9a9022..5446500 100644 --- a/docs/DocumentationStyleGuide/language-grammar/capitalization.rst +++ b/docs/DocumentationStyleGuide/language-grammar/capitalization.rst @@ -21,3 +21,25 @@ The guidelines in this case are: - Headline style capitalization should be employed as per the context, like blog posts, research paper titles to use initial uppercase letters for all significant words in the text. +- More detailed explanation on sentence case: + In sentence case, lowercase most words in a title or heading. Capitalize only the following words: + - The first word of the title or heading + - The first word of a subtitle + - The first word after a colon, em dash, or end punctuation in a heading + - Nouns followed by numerals or letters + - Proper nouns (such as the names of racial or ethnic groups) + ++-------------------------------------+--------------------------------------------+ +| Recommended examples | Not recommended examples | ++=====================================+============================================+ +| Contents: | contents: | +| Setup Git | setup git | +| Install and Configure Git | Install and Configure Git | ++-------------------------------------+--------------------------------------------+ +| # Github Workflow | # github workflow | +| example of headline style | proper headline style capitalization | +| capitalization. | is a must, modify depending to context. | ++-------------------------------------+--------------------------------------------+ +| Issue raised based on FLINT | issue raised based on FLINT Documentation: | +| documentation : Self-reported issue | seld-reported issue | ++-------------------------------------+--------------------------------------------+ From 1dd34129313df61a568d422ef273bb5dac1dfcbf Mon Sep 17 00:00:00 2001 From: manojtummala Date: Fri, 1 Oct 2021 18:52:50 +0530 Subject: [PATCH 2/3] Update capitalization.rst Signed-off-by: Manoj Tummala --- .../DocumentationStyleGuide/language-grammar/capitalization.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/DocumentationStyleGuide/language-grammar/capitalization.rst b/docs/DocumentationStyleGuide/language-grammar/capitalization.rst index 5446500..4ab9a66 100644 --- a/docs/DocumentationStyleGuide/language-grammar/capitalization.rst +++ b/docs/DocumentationStyleGuide/language-grammar/capitalization.rst @@ -22,7 +22,7 @@ The guidelines in this case are: like blog posts, research paper titles to use initial uppercase letters for all significant words in the text. - More detailed explanation on sentence case: - In sentence case, lowercase most words in a title or heading. Capitalize only the following words: + - In sentence case, lowercase most words in a title or heading. Capitalize only the following words: - The first word of the title or heading - The first word of a subtitle - The first word after a colon, em dash, or end punctuation in a heading From 3104523917091714a71b7f6669ee086179b1e1cf Mon Sep 17 00:00:00 2001 From: manojtummala Date: Fri, 1 Oct 2021 19:13:23 +0530 Subject: [PATCH 3/3] Update capitalization.rst Signed-off-by: Manoj Tummala --- .../language-grammar/capitalization.rst | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/DocumentationStyleGuide/language-grammar/capitalization.rst b/docs/DocumentationStyleGuide/language-grammar/capitalization.rst index 4ab9a66..bc3edf2 100644 --- a/docs/DocumentationStyleGuide/language-grammar/capitalization.rst +++ b/docs/DocumentationStyleGuide/language-grammar/capitalization.rst @@ -29,17 +29,17 @@ The guidelines in this case are: - Nouns followed by numerals or letters - Proper nouns (such as the names of racial or ethnic groups) -+-------------------------------------+--------------------------------------------+ -| Recommended examples | Not recommended examples | -+=====================================+============================================+ -| Contents: | contents: | -| Setup Git | setup git | -| Install and Configure Git | Install and Configure Git | -+-------------------------------------+--------------------------------------------+ -| # Github Workflow | # github workflow | -| example of headline style | proper headline style capitalization | -| capitalization. | is a must, modify depending to context. | -+-------------------------------------+--------------------------------------------+ -| Issue raised based on FLINT | issue raised based on FLINT Documentation: | -| documentation : Self-reported issue | seld-reported issue | -+-------------------------------------+--------------------------------------------+ ++----------------------------------------------+------------------------------------------------------+ +| Recommended examples | Not recommended examples | ++==============================================+======================================================+ +| Contents: | contents: | +| - Setup Git | - setup git | +| - Install and Configure Git | - Install and Configure Git | ++----------------------------------------------+------------------------------------------------------+ +| Github Workflow | github workflow | +| - example of headline style capitalization. | - proper headline style capitalization is must | +| | - modify depending to context. | ++----------------------------------------------+------------------------------------------------------+ +| Issue raised based on FLINT | issue raised based on FLINT Documentation: | +| documentation : Self-reported issue | seld-reported issue | ++----------------------------------------------+------------------------------------------------------+