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

Standardise UG format #53

Merged
merged 2 commits into from
Oct 6, 2023
Merged
Show file tree
Hide file tree
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
26 changes: 15 additions & 11 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,17 +139,21 @@ Displays a list of all tutors in the address book in a table format.
**Example**:
* `list-t`

**Acceptable values for each parameter**:
* No acceptable values as list-t has no parameters

**Expected Output**:
* Displays a table of tutors with columns for Name, Phone Number, and Email like
the [image](#listing-all-tutors--list-t) above
* `Listed all tutors`
* If there are no tutors in the address book, displays a message telling the user
to add a tutor with add-t: `There are no tutors in the address book. Please use /add-t to add a tutor.`
to add a tutor with add-t: `There are no tutors in the address book. Please use add-t to add a tutor.`

**Error messages**:
* No error messages as this command ignores extra parameters.
<div markdown="block" class="alert alert-info">

**:information_source: Information**<br>

* list-t command does not take in any parameters.
* Any extraneous parameters after `list-t` will be ignored.
e.g. if the command specifies `list-t 123`, it will be interpreted as `list-t`.
* No error messages as anything typed behind is ignored.

</div>

### Adding a schedule: `add-s`

Expand Down Expand Up @@ -204,14 +208,14 @@ Deletes a tutor in the address book based on their index number in the table.

**Examples**:
* `delete-t 5` deletes the tutor that is indexed as 5 in the address book.
* `list` followed by `delete-t 2` deletes the 2nd person in the address book.
* `list` followed by `delete-t 2` deletes the 2nd tutor in the address book.

**Acceptable values for each parameter**:
* `TUTOR_INDEX`: Only accepts numerical value

**Expected output**:
* `Tutor has been deleted: Alex Yeoh; Phone: 87438807;
Email: [email protected]; Address: Blk 30 Geylang Street 29, #06-40`
* `Tutor has been deleted: Bernice Yu; Phone: 99272758;
Email: [email protected]`

**Error messages**:
* `Index number given is out of range`: Given index is out of range.
Expand Down
Binary file modified docs/images/deleteTutor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/listTutor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading