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 #47 from doyelee0313/Update-UG
Update UG
- Loading branch information
Showing
1 changed file
with
6 additions
and
6 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 |
|---|---|---|
|
|
@@ -63,7 +63,7 @@ TutorsContactsPro is a **desktop app for tutors teaching Computer Science course | |
|
|
||
| * `add n/John Doe p/98765432 e/[email protected] y/2 m/Computer Science tg/johndoe r/Very quiet student g/TUT04 g/LAB10 ` : Adds a student named `John Doe` to the list. | ||
|
|
||
| * `edit 1 /name John /email [email protected] /year 2 /major Computer science /tut T02 /tg` : Edits the first student on the current list. | ||
| * `edit 1 p/93840823 y/3 tg/jiejfh203` : Edits the first student on the current list. | ||
|
|
||
| * `Find John` : Lists all the students with the name 'John' | ||
|
|
||
|
|
@@ -139,18 +139,18 @@ Examples: | |
|
|
||
| Edits an existing student you have selected. | ||
|
|
||
| Format: `edit INDEX [name/NAME] [email/EMAIL] [year/NUMBER] [major/MAJOR] [tut/TUTORIAL_SLOT] [phone/PHONE_NUMBER] [tg/TELEGRAM_HANDLE] [rem/REMARKS]` | ||
| Format: `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [y/YEAR] [m/MAJOR] [tg/TELEGRAM_HANDLE] [r/REMARK] [g/Group]` | ||
|
|
||
| * Edits the student at the specified `INDEX`. The index refers to the index number shown in the displayed student list. The index **must be a positive integer** 1, 2, 3, … | ||
| * At least one of the optional fields must be provided. | ||
| * Existing values will be updated to the input values. | ||
| * When editing groups, the existing groups of the student will be removed i.e adding of groups is not cumulative. | ||
| * You can remove all the student’s groups by typing `t/` without | ||
| * You can remove all the student’s groups by typing `g/` without | ||
| specifying any groups after it. | ||
|
|
||
| Examples: | ||
| * `edit 1 name/John email/[email protected]` Edits the name of the first student to `John` and email to `[email protected]` respectively. | ||
| * `edit 2 name/Betty tg/` Edits the name of the 2nd student to be `Betsy` and clears her telegram handle. | ||
| * `edit 1 n/John e/[email protected]` Edits the name of the first student to `John` and email to `[email protected]` respectively. | ||
| * `edit 2 n/Betty tg/` Edits the name of the 2nd student to be `Betsy` and clears her telegram handle. | ||
|
|
||
| ### <span id='feature-find'> Locating students by keyword: `find` <span> | ||
|
|
||
|
|
@@ -237,7 +237,7 @@ _Details coming soon ..._ | |
| | **Help** | `help` | | ||
| | **List** | `list` | | ||
| | **Add** | `add n/NAME p/PHONE e/EMAIL y/YEAR m/MAJOR tg/TELEGRAM [r/REMARK] [g/Group]...` <br> e.g., `add n/John Doe p/98765432 e/[email protected] y/2 m/Computer Science tg/johndoe r/Very quiet student g/TUT04 g/LAB10 ` | | | ||
| | **Edit** | `edit INDEX [name/NAME] [email/EMAIL] [year/NUMBER] [major/MAJOR] [tut/TUTORIAL_SLOT] [phone/PHONE_NUMBER] [tg/TELEGRAM_HANDLE] [rem/REMARKS]`<br> e.g., `edit 1 name/John email/[email protected]` | | ||
| | **Edit** | `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [y/NUMBER] [m/MAJOR] [tg/TELEGRAM] [r/REMARK] [g/Group]`<br> e.g., `edit 1 n/John e/[email protected]` | | ||
| | **Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g.,`find john` | | ||
| | **Delete** | `delete INDEX`<br> e.g., `delete 1` | | ||
| | **Clear** | `clear` | | ||