Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update user guide for delete feature #17

Merged
merged 2 commits into from
Feb 29, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,12 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo

* `list` : Lists all contacts.

* `add n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book.

* `delete 3` : Deletes the 3rd contact shown in the current list.
* `add id/A01234567H n/John Doe e/[email protected]` : Adds a student named `John Doe` to the list.

* `clear` : Deletes all contacts.
* `delete A0123456X` : Deletes the student with student id A0123456X from the list.

* `clear` : Deletes all students.

* `exit` : Exits the app.

Expand Down Expand Up @@ -129,17 +130,17 @@ Examples:

### Deleting a person : `delete`

Deletes the specified person from the address book.
Deletes the specified student from the list.

Format: `delete STUDENT_ID`

Format: `delete INDEX`
* Deletes the person at the specified `STUDENT_ID`.
* The STUDENT_ID refers to the id corresponding to the student in the list.
* The STUDENT_ID is case-insensitive, must be a String starting with ‘A’ and ending with any letter, with a total length of 9

* Deletes the person at the specified `INDEX`.
* The index refers to the index number shown in the displayed person list.
* The index **must be a positive integer** 1, 2, 3, …​

Examples:
* `list` followed by `delete 2` deletes the 2nd person in the address book.
* `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command.
* `delete A0123456X` deletes the student with student id A0123456X from the list.

### Clearing all entries : `clear`

Expand Down
Loading