From b8a3089a1c7dfecb5b9a241d88ec1b8c48f34980 Mon Sep 17 00:00:00 2001 From: shuiyao-sg Date: Mon, 11 Nov 2019 00:46:23 +0800 Subject: [PATCH] Add remark for special notation (monospaced text) in DG --- docs/DeveloperGuide.adoc | 4 ++++ docs/UserGuide.adoc | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/DeveloperGuide.adoc b/docs/DeveloperGuide.adoc index 8c825fcf551..7133b7887c1 100644 --- 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 <>. +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 <>. diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index c0f33e28ce7..b7f3baede8d 100644 --- 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` +