Skip to content

Commit efdc683

Browse files
committed
Fix some typos in UG
1 parent 9cdb6ca commit efdc683

3 files changed

Lines changed: 25 additions & 18 deletions

File tree

docs/UserGuide.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ their profile pictures.
3030

3131
* **`listp`** : Lists all contacts.
3232

33-
* **`add`**`n/John Doe ph/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to MeetBuddy.
33+
* **`addp`**`n/John Doe ph/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to MeetBuddy.
3434

35-
* **`delete`**`3` : Deletes the 3rd contact shown in the current list.
35+
* **`deletep`**`3` : Deletes the 3rd contact shown in the current list.
3636

3737
* **`exit`** : Exits the app.
3838

@@ -117,7 +117,7 @@ If your changes to the data file makes its format invalid, MeetBuddy will discar
117117

118118
Adds a person to MeetBuddy.
119119

120-
Format: `add n/NAME ph/PHONE_NUMBER e/EMAIL a/ADDRESS [g/GROUP]`
120+
Format: `addp n/NAME [ph/PHONE] [e/EMAIL] [a/ADDRESS] [g/GROUP]...`
121121

122122
<div markdown="span" class="alert alert-primary">:bulb: **Tip:**
123123
A person can have any number of groups (including 0)
@@ -127,8 +127,8 @@ In MeetBuddy we assume that all the persons in the contact list have different n
127127
</div>
128128

129129
Examples:
130-
* `add n/John Doe ph/98765432 e/johnd@example.com a/John street, block 123, #01-01`
131-
* `add n/Betsy Crowe g/CS2103 e/betsycrowe@example.com a/Newgate Prison ph/1234567 g/badminton`
130+
* `addp n/John Doe ph/98765432 e/johnd@example.com a/John street, block 123, #01-01`
131+
* `addp n/Betsy Crowe g/CS2103 e/betsycrowe@example.com a/Newgate Prison ph/1234567 g/badminton`
132132

133133
### Listing all persons : `listp`
134134

@@ -210,9 +210,11 @@ Format: `sortp by/FIELD d/DIRECTION`
210210
* Sort by email : `EMAIL`
211211
* Sort by phone number : `PHONE`
212212
* Sort by address : `ADDRESS`
213+
* These are all case-insensitive
213214
* `DIRECTION` is only restricted to the following cases:
214215
* Sort by ascending alphabetical order : `ASC`
215216
* Sort by descending alphabetical order : `DESC`
217+
* These are all case-insensitive
216218

217219
Examples:
218220
* `sortp by/NAME d/ASC` sorts the persons by name and present the result in ascending alphabetical order.
@@ -277,13 +279,17 @@ Examples:
277279

278280
### Locating meetings: `findm`
279281

280-
Finds meetings whose information contain any of the given keywords.
282+
Finds meetings that satisfy all the given criteria.
281283

282-
Format: `findm [n/NAME] [time/TIME] [desc/DESCRIPTION] [pr/PRIORITY] [g/GROUP]...[p/INDEX OF PERSON RELATED]...`
284+
Format: `findm [n/NAME] [time/TIME]... [desc/DESCRIPTION] [pr/PRIORITY] [g/GROUP]... [p/INDEX OF PERSON RELATED]...`
283285

286+
* Though all fields are optional, we require the user to enter at least one.
284287
* The search is case-sensitive in name searching. e.g `CS2103` will not match `cs2103`
285288
* The order of the searching filed does not matter. e.g. `findm n/CS pr/3` will be the same as `findm pr/3 n/CS`.
286-
* Time field refers to a point of time, as long as this point of time is in between of a meeting's start time and ending time, the search will return this specific meeting.
289+
* Time field refers to a point of time, as long as this point of time is
290+
in between of a meeting's start time and ending time (inclusive),
291+
the search will return this specific meeting.
292+
* The user can enter many times. The meetings will have to satisfy all of them.
287293
* Time field must follow YYYY-MM-DD HH:MM format.
288294
* For other fields, the requirement is the same as addm (Adding a meeting). You can refer to the previous UG instruction.
289295

@@ -304,7 +310,6 @@ Format: `showm INDEX`
304310

305311
### Sorting of meetings : `sortm`
306312

307-
308313
Sorts the meetings displayed according to a specified field.
309314

310315
Format: `sortm by/FIELD d/DIRECTION`
@@ -316,9 +321,11 @@ Format: `sortm by/FIELD d/DIRECTION`
316321
* Sort by end time : `END`
317322
* Sort by priority : `PRIORITY`
318323
* Sort by description : `DESCRIPTION`
324+
* These are all case-insensitive
319325
* `DIRECTION` is only restricted to the following cases:
320326
* Sort by ascending order : `ASC`
321327
* Sort by descending order : `DESC`
328+
* These are all case-insensitive
322329
Examples:
323330
* `sortm by/PRIORITY d/ASC` sorts the meetings by priority and present the result in ascending order.
324331

@@ -402,13 +409,13 @@ Examples:
402409

403410
Action | Format, Examples
404411
--------|------------------
405-
**Add** | `addp n/NAME ph/PHONE_NUMBER e/EMAIL a/ADDRESS [g/GROUP]…​` <br> e.g., `addp n/James Ho ph/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 g/CS2106 g/badminton` <br> <br> `addm n/NAME st/START TIME ed/END TIME desc/DESCRIPTION pr/PRIORITY [g/GROUP]...[p/INDEX OF PERSON RELATED]...` <br> e.g., `addm n/CS2103 Lecture st/2021-03-12 14:00 ed/2021-03-12 16:00 desc/Week 7 pr/3 g/lectures g/SoC p/1 p/2`
412+
**Add** | `addp n/NAME [ph/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [g/GROUP]…​` <br> e.g., `addp n/James Ho ph/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 g/CS2106 g/badminton` <br> <br> `addm n/NAME st/TIME ed/TIME [desc/DESCRIPTIONS] [pr/PRIORITY] [p/PERSON RELATED INDEX]… [g/GROUP]…` <br> e.g., `addm n/CS2103 Lecture st/2021-03-12 14:00 ed/2021-03-12 16:00 desc/Week 7 pr/3 g/lectures g/SoC p/1 p/2`
406413
**Delete** | `deletep INDEX`<br> e.g., `deletep 3` <br> <br> `deletem INDEX`<br> e.g., `deletem 3`
407414
**Edit** | `editp INDEX [n/NAME] [ph/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [g/GROUP]…​`<br> e.g.,`editp 2 n/James Lee e/jameslee@example.com` <br> <br> `editm INDEX [n/NAME] [st/START TIME] [ed/END TIME] [desc/DESCRIPTION] [pr/PRIORITY] [p/PERSON RELATED INDEX] [g/GROUP]...​`<br> e.g.,`editm 2 n/CS2103 Lecture`
408-
**Find** | `findp KEYWORD [MORE_KEYWORDS]`<br> e.g., `findp James Jake` <br> <br> `findpg KEYWORD [MORE_KEYWORDS]`<br> e.g., `findpg badminton` <br> <br> `findm [n/NAME] [time/TIME] [desc/DESCRIPTION] [pr/PRIORITY] [g/GROUP]...[p/INDEX OF PERSON RELATED]...`<br> e.g., `findm n/CS pr/3` <br>
415+
**Find** | `findp KEYWORD [MORE_KEYWORDS]`<br> e.g., `findp James Jake` <br> <br> `findpg KEYWORD [MORE_KEYWORDS]`<br> e.g., `findpg badminton` <br> <br> `findm [n/NAME] [time/TIME]... [desc/DESCRIPTION] [pr/PRIORITY] [g/GROUP]... [p/INDEX OF PERSON RELATED]...`<br> e.g., `findm n/CS pr/3` <br>
409416
**List** | `list`, `listm`, `listp`
410417
**Sort** | `sortp by/FIELD d/DIRECTION` <br> `sortm by/FIELD d/DIRECTION`
411418
**Help** | `help`
412419
**SetTimetable**| `setTimetable DATE`
413-
**AddPersonRelatedToAMeeting**|`addptm INDEX p/PERSON RELATED INDEX1 p/PERSON RELATED INDEX2… ​`
414-
**DeletePersonRelatedFromAMeeting**|`deletepfm INDEX p/PERSON RELATED INDEX1 p/PERSON RELATED INDEX2… ​`
420+
**AddPersonRelatedToAMeeting**|`addptm INDEX p/PERSON RELATED INDEX1 [p/PERSON RELATED INDEX2]… ​`
421+
**DeletePersonRelatedFromAMeeting**|`deletepfm INDEX p/PERSON RELATED INDEX1 [p/PERSON RELATED INDEX2]… ​`

src/main/java/seedu/address/logic/commands/meetings/FindMeetingCommand.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ public class FindMeetingCommand extends Command {
3232
+ "specified criteria.\n"
3333
+ "Parameters: "
3434
+ "[" + PREFIX_NAME + "NAME] "
35-
+ "[" + PREFIX_TIME + "TIME] "
35+
+ "[" + PREFIX_TIME + "TIME]... "
3636
+ "[" + PREFIX_DESCRIPTION + "DESCRIPTION] "
3737
+ "[" + PREFIX_PRIORITY + "PRIORITY] "
38-
+ "[" + PREFIX_GROUP + "GROUP]..."
38+
+ "[" + PREFIX_GROUP + "GROUP]... "
3939
+ "[" + PREFIX_PERSON_CONNECTION + "INDEX OF PERSON RELATED]...\n"
4040
+ "Example: " + COMMAND_WORD + " "
4141
+ PREFIX_NAME + "CS2103 Lecture "

src/main/java/seedu/address/logic/commands/persons/AddPersonCommand.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ public class AddPersonCommand extends Command {
2323
public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a person to the address book. "
2424
+ "Parameters: "
2525
+ PREFIX_NAME + "NAME "
26-
+ PREFIX_PHONE + "PHONE "
27-
+ PREFIX_EMAIL + "EMAIL "
28-
+ PREFIX_ADDRESS + "ADDRESS "
26+
+ "[" +PREFIX_PHONE + "PHONE] "
27+
+ "[" +PREFIX_EMAIL + "EMAIL] "
28+
+ "[" +PREFIX_ADDRESS + "ADDRESS] "
2929
+ "[" + PREFIX_GROUP + "GROUP]...\n"
3030
+ "Example: " + COMMAND_WORD + " "
3131
+ PREFIX_NAME + "John Doe "

0 commit comments

Comments
 (0)