Skip to content

Commit a38f3e9

Browse files
authored
Merge pull request #55 from ngquyduc/ug-update
Update UG Features section
2 parents 3db5ed5 + 3a7549a commit a38f3e9

File tree

1 file changed

+46
-15
lines changed

1 file changed

+46
-15
lines changed

docs/UserGuide.md

Lines changed: 46 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ HobbyList is a **desktop app for managing hobby activities, optimized for use vi
2626

2727
* **`list`** : Lists all hobby activities in HobbyList.
2828

29-
* **`add`**`n/Badminton d/play badminton [t/sport]` : Adds a hobby activity named `Badminton` to the list.
29+
* **`add`**`n/42km run d/NUS Run event [t/sport]` : Adds a hobby activity named `42km run` to the list.
3030

3131
* **`delete`**`3` : Deletes the 3rd hobby activity shown in the current list.
3232

@@ -43,19 +43,19 @@ HobbyList is a **desktop app for managing hobby activities, optimized for use vi
4343
**:information_source: Notes about the command format:**<br>
4444

4545
* Words in `UPPER_CASE` are the parameters to be supplied by the user.<br>
46-
e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`.
46+
e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/42km run`.
4747

4848
* Items in square brackets are optional.<br>
49-
e.g. `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`.
49+
e.g. `n/NAME [t/TAG]` can be used as `n/42km run t/sport` or as `n/42km run`.
5050

5151
* Items with ``​ after them can be used multiple times including zero times.<br>
52-
e.g. `[t/TAG]…​` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc.
52+
e.g. `[t/TAG]…​` can be used as ` ` (i.e. 0 times), `t/sport`, `t/sport t/cardio` etc.
5353

5454
* Parameters can be in any order.<br>
55-
e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable.
55+
e.g. if the command specifies `n/NAME d/DESCRIPTION`, `d/DESCRIPTION n/NAME` is also acceptable.
5656

5757
* If a parameter is expected only once in the command, but you specified it multiple times, only the last occurrence of the parameter will be taken.<br>
58-
e.g. if you specify `p/12341234 p/56785678`, only `p/56785678` will be taken.
58+
e.g. if you specify `d/NUS Run d/NUS Biathlon`, only `d/NUS Biathlon` will be taken.
5959

6060
* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.<br>
6161
e.g. if the command specifies `help 123`, it will be interpreted as `help`.
@@ -69,16 +69,28 @@ Adds a hobby activity to HobbyList.
6969
Format: `add n/NAME d/DESCRIPTION [t/TAG]`
7070

7171
Examples:
72+
* `add n/42km run d/NUS Run event [t/sport]`
7273
* `add n/Badminton d/play badminton [t/sport]`
73-
* `add n/Pottery d/make pottery [t/art]`
74-
7574

7675
### Listing all hobby activities : `list`
7776

7877
Shows a list of all hobby activities in HobbyList.
7978

8079
Format: `list`
8180

81+
Example:
82+
* `list`
83+
84+
### Finding a command with keywords: `find`
85+
86+
Shows a list of all hobby activities whose names contain any of the specified keywords.
87+
88+
Format: `find KEYWORD`
89+
90+
* The keywords are case-insensitive.
91+
92+
Example:
93+
* `find run`
8294

8395
### Deleting an activity : `delete`
8496

@@ -90,13 +102,30 @@ Format: `delete INDEX`
90102
* The index refers to the index number shown in the displayed activity list.
91103
* The index **must be a positive integer** 1, 2, 3, …​
92104

105+
Example:
106+
107+
* `delete 1`
108+
109+
### Deleting all activities: clear
110+
111+
Deletes all activities from HobbyList
112+
113+
Format: `clear`
114+
115+
Example:
116+
117+
* `clear`
93118

94119
### Exiting the program : `exit`
95120

96121
Exits the program.
97122

98123
Format: `exit`
99124

125+
Example:
126+
127+
* `exit`
128+
100129
### Saving the data
101130

102131
HobbyList data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
@@ -106,7 +135,7 @@ HobbyList data are saved in the hard disk automatically after any command that c
106135
HobbyList data are saved as a JSON file `[JAR file location]/data/hobbylist.json`. Advanced users are welcome to update data directly by editing that data file.
107136

108137
<div markdown="span" class="alert alert-warning">:exclamation: **Caution:**
109-
If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run.
138+
If your changes to the data file makes its format invalid, HobbyList will discard all data and start with an empty data file at the next run.
110139
</div>
111140

112141
--------------------------------------------------------------------------------------------------------------------
@@ -120,10 +149,12 @@ If your changes to the data file makes its format invalid, AddressBook will disc
120149

121150
## Command summary
122151

123-
| Action | Format |
124-
|-------------------------|------------------------------------|
125-
| **Add activity** | `add n/NAME d/DESCRIPTION [t/TAG]` |
126-
| **Delete activity** | `delete INDEX` |
127-
| **List all activities** | `list` |
128-
| **Exit** | `exit` |
152+
| Action | Format |
153+
|---------------------------|------------------------------------|
154+
| **Add an activity** | `add n/NAME d/DESCRIPTION [t/TAG]` |
155+
| **Find an activity** | `find KEYWORD` |
156+
| **Delete an activity** | `delete INDEX` |
157+
| **List all activities** | `list` |
158+
| **Delete all activities** | `clear` |
159+
| **Exit** | `exit` |
129160

0 commit comments

Comments
 (0)