forked from nus-cs2103-AY2324S2/tp
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from modembcc/master
Update PR to latest version
- Loading branch information
Showing
1 changed file
with
20 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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/[email protected] a/John street, block 123, #01-01` | ||
* `add n/Betsy Crowe t/friend e/[email protected] 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` | ||
|
||
|
@@ -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` | ||
|
||
|
@@ -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/[email protected] 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/[email protected]` | ||
**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake` | ||
**List** | `list` | ||
|