Merge pull request #191 from shuiyao-sg/branch-Doc

[SHUI YAO]Add remark for special notation (monospaced text) in DG
Parcly-Taxel · Nov 10, 2019 · 4978a7b · 4978a7b
2 parents 839eb3b + b8a3089
commit 4978a7b
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/docs/DeveloperGuide.adoc b/docs/DeveloperGuide.adoc
@@ -24,6 +24,10 @@ for its implementation so that you can start contributing in no time.
 
 For any queries, simply <<ContactUs#, contact us>>.
 
+NOTE: In this document, `monospaced` texts may have different meanings. If the text is in *PascalCase* i.e. first letter
+of each word is capitalised, such as `Logic`, then the text is a class or interface name. If the text has a bracket such as `execute("delete 1")`.
+Otherwise, the `monospaced` texts are meant for highlighting or user commands depending on the context.
+
 == Setting up
 
 Refer to the guide <<SettingUp#, here>>.

diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc
@@ -776,7 +776,7 @@ eg. `report 7` +
 eg. `overview dt/20/10/2019 dt/06/11/2019` +
 
 *Adding a revision task for note*: `rn t/TITLE_OF_NOTE dt/DATE tm/TIME` +
-eg. `rn t/CS2103T UML diagram dt/01/11/2019 tm/0900`+
+eg. `rn t/CS2103T UML diagram dt/01/11/2019 tm/0900` +
 
 *Adding a revision task for question*: `rq i/INDEX_OF_QUESTION dt/DATE tm/TIME` +
 eg. `rq i/1 dt/11/11/2019 tm/1500` +