Skip to content

Added examples for Capitalization #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
manojtummala wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Added examples for Capitalization #116

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e17b20c
added examples for Capitalization
manojtummala Oct 1, 2021
1dd3412
Update capitalization.rst
manojtummala Oct 1, 2021
3104523
Update capitalization.rst
manojtummala Oct 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/DocumentationStyleGuide/language-grammar/capitalization.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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 |
+----------------------------------------------+------------------------------------------------------+