Skip to content

Commit

Permalink
Merge pull request #290 from jun-ha0/jun-ha0-branch
Browse files Browse the repository at this point in the history
Update documentation
  • Loading branch information
jun-ha0 committed Nov 11, 2019
2 parents be930bd + 69eb961 commit d111dec
Show file tree
Hide file tree
Showing 3 changed files with 125 additions and 6 deletions.
118 changes: 118 additions & 0 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1251,6 +1251,124 @@ p/😄
```
Expected: The engagement is not added. Status bar shows prompt for a valid priority due to invalid priority.

=== Listing an engagement

(i) Test case: `list` +

Expected: Status bar shows the successful listing of engagement. The full engagement list is shown.

(ii) Test case: `123 list` +

Expected: Status bar shows the successful listing of engagement. The full engagement list is shown.

(iii) Test case: `list 123` +

Expected: Status bar shows the successful listing of engagement. The full engagement list is shown.

=== Deleting an engagement

(i) Test case: `delete i/3` +

Expected: If there are 3 or more engagements in the engagement list, the 3rd engagement is deleted.
Status bar shows the successful deletion of engagement with its details. The engagement list is updated accordingly.
Otherwise, the engagement is not deleted due to invalid index.

(ii) Test case: +
The sequence of commands is as follows:
```
delete
i/3
```
Expected: If there are 3 or more engagements in the engagement list, the 3rd engagement is deleted.
Status bar shows the successful deletion of engagement with its details. The engagement list is updated accordingly.
Otherwise, the engagement is not deleted due to invalid index.

(ii) Test case: `delete i/-1` +

Expected: The engagement is not deleted due to invalid index.

(iii) Test case: +
The sequence of commands is as follows:
```
delete
i/-1
```
Expected: The engagement is not deleted due to invalid index.

=== Finding an engagement

(i) Test case: `find d/Singapore based`

Expected: Engagements containing description keyword will be shown. e.g. will show
all engagements containing the description `Singapore based`. +
e.g. `singapore based internship appointment`, `Singapore based project meeting`

(ii) Test case: +
The sequence of commands is as follows:
```
find
d/Singapore based
```
Expected: Engagements containing description keyword will be shown. e.g. will show
all engagements containing the description `Singapore based`. +
e.g. `singapore based internship appointment`, `Singapore based project meeting`

(iii) Test case: `find l/Com Basement`

Expected: Engagements matching the full exact keyword will be shown. e.g. will show
all engagements containing the location `Com Basement`. Note that engagement with location `Basement Room 6` will not be shown.

(iv) Test case: +
The sequence of commands is as follows:
```
find
l/Com Basement
```
Expected: Engagements matching the full exact keyword will be shown. e.g. will show
all engagements containing the location `Com Basement`. Note that engagement with location `Basement Room 6` will not be shown.

(v) Test case: `find a/Hans`

Expected: Engagements containing attendee keyword will be shown. e.g. `find a/Hans` will show
all engagements containing the attendee `Hans`. +
e.g. `Hansen Gruber`, `hans christian`

(vi) Test case: `find a/Hans` +
The sequence of commands is as follows:
```
find
a/Hans
```

Expected: Engagements containing attendee keyword will be shown. e.g. `find a/Hans` will show
all engagements containing the attendee `Hans`. +
e.g. `Hansen Gruber`, `hans christian`

(vii) Test case: `find p/High`

Expected: Engagements containing high priority will be shown.

(viii) Test case: +
The sequence of commands is as follows:
```
find
p/High
```

Expected: Engagements containing high priority will be shown.

(ix) Test case: `find a/Hans p/high`

Expected: Engagements containing the attendee `Hans` and with high priority will be shown.

(ix) Test case: +
The sequence of commands is as follows:
```
find
a/Hans p/high`
```
Expected: Engagements containing the attendee `Hans` and with high priority will be shown.


//tag::yuchen-test[]
=== Sorting the engagement list
Expand Down
11 changes: 6 additions & 5 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,7 @@ After sorting, commands that require INDEX as an input field (e.g. `delete`) wil
Finds engagements whose names contain any of the given keywords. Engagements can be in different types: `Appointment`, `Meeting` and `Interview`.
Searches can be interactive or non-interactive.

Format: `find TAG/KEYWORD`
Format: `find l/LOCATION d/DESCRIPTION a/ATTENDEES p/PRIORITY`

Valid tags: `d/`, `l/`, `a/`, `p/` +

Expand All @@ -438,7 +438,7 @@ The non-interactive equivalent of this sequence is `find l/Com Basement`.

|Description
|`d/`
|Engagements containing description keyword will be returned. e.g. `find d/Singapore based` will return
|Engagements containing description keyword will be shown. e.g. `find d/Singapore based` will show
all engagements containing the description `Singapore based`. +
e.g. `singapore based internship appointment`, `Singapore based project meeting`

Expand All @@ -448,7 +448,7 @@ e.g. `singapore based internship appointment`, `Singapore based project meeting`

|Attendees
|`a/`
|Engagements containing attendee keyword will be returned. e.g. `find a/Hans` will return
|Engagements containing attendee keyword will be shown. e.g. `find a/Hans` will show
all engagements containing the attendee `Hans`. +
e.g. `Hansen Gruber`, `hans christian`

Expand All @@ -460,7 +460,7 @@ e.g. `Hansen Gruber`, `hans christian`
****
* All search are case insensitive. e.g `find a/hans` is equivalent to `find a/Hans`
* At least one search parameter should be specified.
* The order of the prefixes does not matter. e.g. `find a/Hans Bo p/high` is equivalent to `find p/high a/Hans`
* The order of the prefixes does not matter. e.g. `find a/Hans p/high` is equivalent to `find p/high a/Hans`
* Similarly, the two sequences below are similar.
```
find
Expand Down Expand Up @@ -800,10 +800,11 @@ e.g. `calendar c/closedisplay d/11/11/2019`
** *Previous Month* : `calendar c/previousmonth`
* *Clear* : `clear`
* *Delete* : `delete i/INDEX` +
e.g. `delete i/3`
** `delete i/3`
* *PDF* : `pdf i/INDEX to/RECEIVER from/SENDER`
* *Redo* : `redo`
* *Sort* : `sort p/PROPERTY o/ORDER`
* *Undo* : `undo`
* *List* : `list`
* *Find* `find l/LOCATION d/DESCRIPTION a/ATTENDEES p/PRIORITY`
* *Help* : `help`
2 changes: 1 addition & 1 deletion docs/team/jun-ha0.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ gives a high level overview of the game.
.Summary Sequence Diagram of Game Window
image::GameSequenceDiagram.png[align="center"]
//image::GameActivityDiagram.png[float="left"]
image::GameActivityDiagram.png[width="30%" align="center"]
image::GameActivityDiagram.png[width="50%" align="center"]
.Activity Diagram of the Game Window

`GameWindow` has three main components `PlayerInformation`, `GameBody` and `Player`.
Expand Down

0 comments on commit d111dec

Please sign in to comment.