forked from nus-cs2103-AY2425S1/tp
-
Notifications
You must be signed in to change notification settings - Fork 5
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 #221 from FionaQY/fix-ug-space
Fix ug space
- Loading branch information
Showing
1 changed file
with
21 additions
and
18 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 |
|---|---|---|
|
|
@@ -235,6 +235,7 @@ Arguments are the values that follow each flag in a command. **Arguments cannot | |
|
|
||
| Refer to the table below for more details. | ||
|
|
||
|
|
||
| | **Flag** | **Expected Argument** | **Description** | **Requirements** | | ||
| |----------|-----------------------|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| | ||
| | `n/` | `<NAME>` | The client's full name | Any combination of letters, numbers, spaces, hyphens, apostrophes (no symbols). | | ||
|
|
@@ -248,6 +249,8 @@ Refer to the table below for more details. | |
| | `r/` | `<REMARK>` | General remark(s) about the client | Any combination of letters, numbers, spaces, and symbols. | | ||
| | `ra/` | `<REMARK TO APPEND>` | Append information to the existing remark(s) | Any combination of letters, numbers, spaces, and symbols. | | ||
| | `rn/` | `<NEW REMARK>` | Replaces the existing remark with a new remark | Any combination of letters, numbers, spaces, and symbols. | | ||
|
|
||
|
|
||
| **Note:** All of the above arguments are case-insensitive. | ||
|
|
||
| > 💡 **Pro Tip:** | ||
|
|
@@ -332,7 +335,7 @@ add n/ <NAME> p/ <PHONE> e/ <EMAIL> a/ <ADDRESS> j/ <JOBNAME> i/ <INCOME> [t/ <T | |
|
|
||
| **Purpose:** Save detailed records of a new client. | ||
|
|
||
| Each client's record includes their name, contact number, email, occupation, and income. You can also enter the optional fields for credit card tier and remark(s) here. Otherwise, new users are assigned a default value of "NA". | ||
| Each client's record includes their name, contact number, email, occupation, and income. You can also enter the optional fields for credit card tier, status and remark(s) here. Otherwise, new users are assigned a default value of "NA". | ||
|
|
||
| **Command Format:** | ||
| ``` | ||
|
|
@@ -406,9 +409,9 @@ All client information, including contact details, address, job information, and | |
|
|
||
| **Command Format:** | ||
| ``` | ||
| edit <INDEX> n/ <NAME> p/ <PHONE> e/ <EMAIL> a/ <ADDRESS> j/ <JOB> i/ <INCOME> [t/ <TIER>] [rn/ <NEW REMARK>] [ra/ <REMARK TO BE APPENDED>] [s/ <STATUS>] | ||
| edit <INDEX> [n/ <NAME>] [p/ <PHONE>] [e/ <EMAIL>] [a/ <ADDRESS>] [j/ <JOB>] [i/ <INCOME>] [t/ <TIER>] [rn/ <NEW REMARK>] [ra/ <REMARK TO BE APPENDED>] [s/ <STATUS>] | ||
| ``` | ||
| - Mandatory Field: `<INDEX>` | ||
| - Mandatory Field: `<INDEX>`, at least one of the Optional Fields | ||
| - Optional Fields: `n/`, `p/`, `e/`, `a/`, `j/`, `i/`, `t/`, `rn/`, `ra/`, `s/` | ||
| - **Note:** `rn/` (new remark(s)) and `ra/` (append remark(s)) cannot be used simultaneously in a single command. | ||
|
|
||
|
|
@@ -481,7 +484,7 @@ For detailed explanations of each flag and acceptable arguments, refer to Sectio | |
|
|
||
| > 💡 **Pro Tip:** | ||
| > No need to worry about duplicate indexes—AgentAssist guarantees that every client has a unique index automatically. | ||
| - **Note:** If the value for either `Tier` and `Status` is the default value (`NA`), they will not be shown. | ||
| - **Note:** If the value for `Tier`, `Status` or `REMARK` is the default value (`NA`), they will not be shown. | ||
|
|
||
|
|
||
|
|
||
|
|
@@ -582,7 +585,7 @@ list | |
|
|
||
| **Command Format:** | ||
| ``` | ||
| filter n/ <NAME> p/ <PHONE> e/ <EMAIL> a/ <ADDRESS> j/ <JOB> r/ <REMARK> t/ <TIER> i/ <INCOME> s/ <STATUS> | ||
| filter [n/<NAME>] [p/<PHONE>] [e/<EMAIL>] [a/<ADDRESS>] [j/<JOB>] [r/<REMARK>] [t/<TIER>] [i/ (=/</>) <INCOME>] [s/<STATUS> | ||
| ``` | ||
| - **Mandatory Field**: One or more flags with corresponding search terms. The search term cannot be left empty. | ||
| - **Special Syntax for Income (i/)**: | ||
|
|
@@ -809,18 +812,18 @@ Each status type is visually distinguished in the UI: Urgent is denoted by a red | |
|
|
||
| ## 8. Command Summary | ||
|
|
||
| | **Action** | **Command Format** | **Example** | | ||
| |----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------| | ||
| | **Add New Client** | `add n/<NAME> p/<PHONE> e/<EMAIL> a/<ADDRESS> j/<JOB> i/<INCOME> [t/<TIER>] [r/<REMARK>] [s/<STATUS>]` | `add n/ GORDON MOORE p/ 99007766 e/ [email protected] a/ COM3 j/ engineer i/ 99999 t/ gold r/ remark s/ urgent` | | ||
| | **Delete Existing Client** | `delete <INDEX>` | `delete 69` | | ||
| | **Edit Existing Client** | `edit <INDEX> n/<NAME> p/<PHONE> e/<EMAIL> a/<ADDRESS> j/<JOB> i/<INCOME> [t/<TIER>] [rn/<NEW REMARK>] [ra/<APPEND REMARK>] [s/<STATUS>]` | `edit 69 n/ GORDON MOORE p/ 77337733 e/ [email protected] a/ COM3 j/ doctor i/ 1000000000 ra/ added info s/ urgent` | | ||
| | **List All Clients** | `list` | `list` | | ||
| | **Filter Client List** | `filter [n/<NAME>] [p/<PHONE>] [e/<EMAIL>] [a/<ADDRESS>] [j/<JOB>] [r/<REMARK>] [t/<TIER>] [i/ (=/</>) <INCOME>] [s/<STATUS>]` | `filter n/ GORDON MOORE j/ doctor t/ gold s/ urgent` | | ||
| | **View Client Details** | `view <INDEX>` | `view 1` | | ||
| | **Close Client Details** | `close` | `close` | | ||
| | **Clear All Data** | `clear` | `clear` | | ||
| | **Undo Command** | `undo` | `undo` | | ||
| | **View Help** | `help` | `help` | | ||
| | **Exit Application** | `exit` | `exit` | | ||
| | **Action** | **Command Format** | **Example** | | ||
| |----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------| | ||
| | **Add New Client** | `add n/<NAME> p/<PHONE> e/<EMAIL> a/<ADDRESS> j/<JOB> i/<INCOME> [t/<TIER>] [r/<REMARK>] [s/<STATUS>]` | `add n/ GORDON MOORE p/ 99007766 e/ [email protected] a/ COM3 j/ engineer i/ 99999 t/ gold r/ remark s/ urgent` | | ||
| | **Delete Existing Client** | `delete <INDEX>` | `delete 69` | | ||
| | **Edit Existing Client** | `edit <INDEX> [n/ <NAME>] [p/ <PHONE>] [e/ <EMAIL>] [a/ <ADDRESS>] [j/ <JOB>] [i/ <INCOME>] [t/ <TIER>] [rn/ <NEW REMARK>] [ra/ <REMARK TO BE APPENDED>] [s/ <STATUS>]` | `edit 69 n/ GORDON MOORE p/ 77337733 e/ [email protected] a/ COM3 j/ doctor i/ 1000000000 ra/ added info s/ urgent` | | ||
| | **List All Clients** | `list` | `list` | | ||
| | **Filter Client List** | `filter [n/<NAME>] [p/<PHONE>] [e/<EMAIL>] [a/<ADDRESS>] [j/<JOB>] [r/<REMARK>] [t/<TIER>] [i/ (=/</>) <INCOME>] [s/<STATUS>]` | `filter n/ GORDON MOORE j/ doctor t/ gold s/ urgent` | | ||
| | **View Client Details** | `view <INDEX>` | `view 1` | | ||
| | **Close Client Details** | `close` | `close` | | ||
| | **Clear All Data** | `clear` | `clear` | | ||
| | **Undo Command** | `undo` | `undo` | | ||
| | **View Help** | `help` | `help` | | ||
| | **Exit Application** | `exit` | `exit` | | ||
|
|
||
| [↑ Return to Table of Contents](#table-of-contents) | ||