From 292f44b86748eaf49aa80a8c25f29cb853d7b334 Mon Sep 17 00:00:00 2001 From: kexiaowen Date: Sun, 15 Apr 2018 20:43:05 +0800 Subject: [PATCH 1/4] Modify UGDG --- docs/DeveloperGuide.adoc | 4 ++-- docs/UserGuide.adoc | 5 +++++ 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/DeveloperGuide.adoc b/docs/DeveloperGuide.adoc index 0a57452ad240..ff4e09c925f0 100644 --- a/docs/DeveloperGuide.adoc +++ b/docs/DeveloperGuide.adoc @@ -1646,14 +1646,14 @@ These instructions only provide a starting point for testers to work on; testers Expected: A student named Damith with the above particulars will be added into HR+. The student will be shown in the persons list panel. .. Add a resume pdf file named resume.pdf to the same folder as the jar file. It also must be valid PDF and smaller than 1MB. + Add an image named image.jpg to the same folder as the jar file. It also must be valid image file and smaller than 1MB. + - Command: `add n/Irene Bae p/83627133 e/irene@sm.com a/341, Woodlands Drive 20, #22-15 u/SNU y/2020 m/Computer Engineering g/4.87 j/Software Tester r/resume.pdf i/image.jpg + + Command: `add n/Irene Bae p/83627133 e/irene@sm.com a/341, Woodlands Drive 20, #22-15 u/SNU y/2020 m/Computer Engineering g/4.87 j/Software Tester r/resume.pdf i/image.jpg` + Expected: A student named Irene is added with the above particulars. A resume and a profile image will be added. === Showing info panel or resume . Showing either student info or resume in the right panel -.. Prerequisites: A student is selected using the `select` command. +.. Prerequisites: A student is selected using the `select` command. The student selected has a resume added into HR+. .. Command: `show resume` + Expected: The resume of the student is displayed when it is available. Command: `show info` + diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index 37efb536aab5..fb0c82e3618b 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -62,6 +62,11 @@ e.g. typing *`help`* and pressing kbd:[Enter] will open the help window. [TIP] The command keywords and parameters are *case sensitive*. +[TIP] +There is a floating real-time parsing panel below the command box that shows parsed results before commands are executed. + +However, it only verifies that the command format is correct. Commands that are shown to be "valid commands" might not execute successfully. + +For example, when you use a correct `add` command format to add a duplicate student into HR+, the real time parser shows that it is a valid command but it will not be successfully executed. + === Viewing help : `help` Format: `help` From d63b8cce382277edb3003021c96e63498d4ee072 Mon Sep 17 00:00:00 2001 From: kexiaowen Date: Sun, 15 Apr 2018 20:46:33 +0800 Subject: [PATCH 2/4] Add more tips in UG --- docs/UserGuide.adoc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index fb0c82e3618b..bac99f2293bd 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -67,6 +67,10 @@ There is a floating real-time parsing panel below the command box that shows par However, it only verifies that the command format is correct. Commands that are shown to be "valid commands" might not execute successfully. + For example, when you use a correct `add` command format to add a duplicate student into HR+, the real time parser shows that it is a valid command but it will not be successfully executed. +[TIP] +If you want to hide the real-time parsing panel, press kbd:[Tab]. + + === Viewing help : `help` Format: `help` From d449d83a5c5ad03f872d09b116ba7a26bed40a8e Mon Sep 17 00:00:00 2001 From: kexiaowen Date: Sun, 15 Apr 2018 20:51:37 +0800 Subject: [PATCH 3/4] Fix whitespace issue --- docs/UserGuide.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index bac99f2293bd..02da274d1e94 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -68,8 +68,7 @@ However, it only verifies that the command format is correct. Commands that are For example, when you use a correct `add` command format to add a duplicate student into HR+, the real time parser shows that it is a valid command but it will not be successfully executed. [TIP] -If you want to hide the real-time parsing panel, press kbd:[Tab]. - +If you want to hide the real-time parsing panel, press kbd:[Tab]. === Viewing help : `help` From 2018342f2c5c83bf655928bd87b783c7bc634199 Mon Sep 17 00:00:00 2001 From: kexiaowen Date: Sun, 15 Apr 2018 20:58:16 +0800 Subject: [PATCH 4/4] Minor update --- docs/UserGuide.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index 02da274d1e94..5e0a049ffde8 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -413,8 +413,8 @@ Examples: * `filter y/2020` + Returns all persons whose graudation year that is exactly 2020 -* `filter y/2019-2021' r/4.3, 4.5-5.0 -Returns all persons whose graduation year between 2019 and 2021, and whose rating is either 4.3, or between 4.5 to 5.0 +* `filter y/2019-2021 r/4.3, 4.5-5.0` +Returns all persons whose graduation year between 2019 and 2021, and whose overall rating score is either 4.3, or between 4.5 to 5.0 Since v1.4, filter command supports filtering by cGPA and interview date. It now takes the format: `Format: `filter [y/KEYWORD_RANGE] [r/KEYWORD_RANGE] [g/CGPA_RANGE] [d/INTERVIEW_DATE_RANGE]`