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.
Add command example no work in command structure overview as its js a…
…n example
- Loading branch information
1 parent
d162c83
commit 8b7f22c
Showing
1 changed file
with
4 additions
and
1 deletion.
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 |
---|---|---|
|
@@ -263,13 +263,14 @@ Let's take a look at the structure in more detail: | |
| **Flag(s)** | Modifiers that specify what kind of data is being handled. <br/><br/>Flag(s) are typically 1-2 letters followed by a backslash. | `n/`, `e/`, `r/`, `rn/` | | ||
| **Argument(s)** | The values or inputs the command uses, such as client data or specific details. <br><br> This guide may represent it as a placeholder using `<ARGUMENT>`. | `John Doe`, `[email protected]` | | ||
|
||
Here's an example that uses multiple flags and arguments: | ||
Here's a snippet of a command that uses multiple flags and arguments: | ||
``` | ||
add n/ John Doe e/ [email protected] | ||
``` | ||
* **Command:** `add` instructs AgentAssist to add a new entry. | ||
* **Flags:** `n/` and `e/` specify the information type (name and email). | ||
* **Arguments:** `John Doe` and `[email protected]` are the actual values being input for the respective flags. | ||
* **Note:** This command is provided as an example for learning purposes only. Additional mandatory flags are needed to make it fully functional, which will be explained in the sections that follow. | ||
|
||
<div style="page-break-after: always;"></div> | ||
|
||
|
@@ -408,6 +409,8 @@ Some initial commands to try: | |
|
||
The GUI will dynamically update to show the results of your commands, making it easy to see the impact of your actions in real time. | ||
|
||
**Note:** The order of flags does not matter. For example, `edit 1 n/ john p/ 92223333` is the same as `edit 1 p/ 92223333 n/ john`. | ||
|
||
Refer to the [Commands Section](#6-commands) for more comprehensive details of each command. | ||
|
||
> 💡 **Pro Tip:** | ||
|