Skip to content
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

Added examples for Abbreviations & Acronyms #137

Merged
merged 7 commits into from
Nov 5, 2021
Merged

Added examples for Abbreviations & Acronyms #137

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f4fc497
docon FLINT Performance
SanjaySinghRajpoot Sep 15, 2021
c5fdce8
Proposed changes
SanjaySinghRajpoot Sep 27, 2021
4d6f73f
Merge branch 'moja-global:master' into master
SanjaySinghRajpoot Oct 9, 2021
bba6984
deleting changes
SanjaySinghRajpoot Oct 10, 2021
dad22fc
deleting changes
SanjaySinghRajpoot Oct 10, 2021
cf96d52
Typo fixed
SanjaySinghRajpoot Oct 11, 2021
6b30b3f
Update abbreviations-acronymn.rst
HarshCasper Nov 5, 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
1 change: 1 addition & 0 deletions docs/DeveloperWorkflow/flint_performance.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@

FLINT Performance
#################

18 changes: 18 additions & 0 deletions docs/DocumentationStyleGuide/language-grammar/abbreviations-acronymn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,21 @@ the same:
- Avoid using the possessive form of the word.
- Connect with the Subject Matter Expert (SME) while deciding to put
common abbreviations (like HTML or PDF) in the user documentation.

+----------------------------------+----------------------------------+
| Recommended examples | Not recommended examples |
+==================================+==================================+
| An element of Moja Global | An ele of Moja Global docs repo. |
| documentation repository. | |
+----------------------------------+----------------------------------+
| I don't know why this file is | IDK why this file is missing. |
| missing. | |
+----------------------------------+----------------------------------+
| We are in a crisis situation | We are in a crisis* situation |
+----------------------------------+----------------------------------+
| John goes to this school. | This is John's school. |
| be found. | be found. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work. What does 'be found' mean here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo I guess. :)

+----------------------------------+----------------------------------+
| After work, I’ll walk over to a | After work, I’ll walk over to a |
| sports arena, e.g., Thunderdome | sports arena, e.g. Thunderdome |
+----------------------------------+----------------------------------+