Skip to content

Commit

Permalink
Merge pull request #1 from modembcc/master
Browse files Browse the repository at this point in the history
Update PR to latest version
  • Loading branch information
modembcc authored Mar 6, 2024
2 parents e4f6e77 + 6517ecd commit 71db047
Showing 1 changed file with 20 additions and 19 deletions.
39 changes: 20 additions & 19 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,19 +72,19 @@ Shows a message explaning how to access the help page.
Format: `help`


### Adding a person: `add`
### Adding a project: `add project`

Adds a person to the address book.
Adds a project to the project manager.

Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​`

<div markdown="span" class="alert alert-primary">:bulb: **Tip:**
A person can have any number of tags (including 0)
</div>
Format: `add project <PROJECT_NAME>`

Examples:
* `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01`
* `add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal`
* `add project CS2103T Duke Chatbot Project`
* `add project CS2101 Presentation`

Expected output:
* Success: `<PROJECT_NAME> has been added to the project list.`
* Failure: `Project <PROJECT_NAME> already exists.`

### Listing all persons : `list`

Expand Down Expand Up @@ -127,19 +127,20 @@ Examples:
* `find alex david` returns `Alex Yeoh`, `David Li`<br>
![result for 'find alex david'](images/findAlexDavidResult.png)

### Deleting a person : `delete`
### Deleting a project : `delete project`

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

Format: `delete INDEX`
Format: `delete project <PROJECT_NAME>`

* 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, …​
* The specified project name must exist in the project list.

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 project CS2101 Presentation`

Expected output:
* Successful deletion: `<PROJECT_NAME> has been deleted from the project list.`
* Failed deletion: `Project <PROJECT_NAME> not found: Please make sure the project exists.`

### Clearing all entries : `clear`

Expand Down Expand Up @@ -189,9 +190,9 @@ _Details coming soon ..._

Action | Format, Examples
--------|------------------
**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​` <br> e.g., `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague`
**Add** | `add project <PROJECT_NAME>` <br> e.g., `add project CS2101 Presentation`
**Clear** | `clear`
**Delete** | `delete INDEX`<br> e.g., `delete 3`
**Delete** | `delete project <PROJECT_NAME>`<br> e.g., `delete project CS2101 Presentation`
**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/jameslee@example.com`
**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
**List** | `list`
Expand Down

0 comments on commit 71db047

Please sign in to comment.