Skip to content

Commit

Permalink
Merge pull request #133 from kexiaowen/v1.5-UGDG
Browse files Browse the repository at this point in the history
Update User Guide and Developer Guide
  • Loading branch information
tanhengyeow authored Apr 15, 2018
2 parents 8a27924 + 2018342 commit 71db28e
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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/[email protected] 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/[email protected] 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` +
Expand Down
12 changes: 10 additions & 2 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,14 @@ 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.

[TIP]
If you want to hide the real-time parsing panel, press kbd:[Tab].

=== Viewing help : `help`

Format: `help`
Expand Down Expand Up @@ -405,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]`
Expand Down

0 comments on commit 71db28e

Please sign in to comment.