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.

Sign up for GitHub

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 #51

Merged
merged 1 commit into from
Oct 5, 2023
Merged

Standardise UG format #51

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 7 additions & 7 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,21 +106,21 @@ Adds a tutor to the address book.

![add tutor](images/addTutor.png)

Format: `add-t n/NAME p/PHONE NUMBER e/EMAIL`
**Format**: `add-t n/NAME p/PHONE NUMBER e/EMAIL`

Example:
**Example**:
* `add-t n/John Doe p/98765432 e/[email protected]`
* `add-t n/Betsy Crowe p/91234567 e/[email protected]`

Acceptable values for each parameter:
* `NAME`: Only string input accepted
* `PHONE`: NUMBER Only numerical input
**Acceptable values for each parameter**:
* `NAME`: Only string input accepted
* `PHONE NUMBER`: Only numerical input
* `EMAIL`: Only valid email addresses

Expected output:
**Expected output**:
* `New tutor John Doe 98765432 [email protected] has been added.`

Error messages:
**Error messages**:
* `Missing parameter: n/`: The tag n/ is missing or tutor’s name is missing.
* `Missing parameter: p/`: The tag p/ is missing or tutor’s phone number is missing.
* `Missing parameter: e/`: The tag e/ is missing or tutor’s email is missing.
Expand Down
Loading