Merge pull request #290 from songfangyl/branch-update-usage-message

Update usage message for remark and find
AY2324S1-CS2103T-W16-2 · Nov 8, 2023 · e941890 · e941890
2 parents 5f975cb + 139ce34
commit e941890
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -206,7 +206,7 @@ After:
 
 **Format:**
 
-`find [n/<keywords>] [p/<keywords>] [e/<keywords>] [a/<keywords>] [t/keywords] [i/<keywords>] [pr/<keywords>] [r/<keywords>]`
+`find [n/[keywords]] [p/[keywords]] [e/[keywords]] [a/[keywords]] [t/[keywords]] [i/[keywords]] [pr/[keywords]] [r/[keywords]]`
 
 **Description:**
 
@@ -693,7 +693,7 @@ command box.
 | **Delete**     | `delete <index>`                                            <hr>       `delete 3`                                                                                                                                                                |
 | **Edit**       | `edit <index> [n/<name>] [p/<phone number>] [e/<email>] [a/<address>] ` <hr> `edit 2 n/James Lee e/[email protected]`                                                                                                                         |
 | **List**       | `list`                                                                      <hr>                                                                                                                                                                 |
-| **Find**       | `find [n/<keywords>] [p/<keywords>] [e/<keywords>] [a/<keywords>] [t/keywords] [i/<keywords>] [pr/<keywords>] [r/<keywords>]`                    <hr>      `find n/song i/abc`                                                                   |
+| **Find**       | `find [n/[keywords]] [p/[keywords]] [e/[keywords]] [a/[keywords]] [t/[keywords]] [i/[keywords]] [pr/[keywords]] [r/[keywords]]`                      <hr>      `find n/song i/abc`                                                               |
 | **Tag**        | `tag <index> [at/<tag to add>]... [dt/<tag to delete>]...`     <hr>         `tag 1 at/tall dt/short at/male`                                                                                                                                     |
 | **Insurance**  | `insurance <index> [ai/<insurance to add>]... [di/<insurance to delete>]...`     <hr>         `insurance 2 ai/AIA insurance di/Great Eastern Insurance`                                                                                          |
 | **Remark**     | `remark <index> [remark]` <hr>   `remark 2 some remarks`                                                                                                                                                                                         |

diff --git a/src/main/java/seedu/address/logic/commands/FindCommand.java b/src/main/java/seedu/address/logic/commands/FindCommand.java
@@ -20,7 +20,8 @@ public class FindCommand extends Command {
 
     public static final String MESSAGE_USAGE =
             "Usage: \n"
-            + COMMAND_WORD + " <prefix> [keywords]... [<prefix> [keywords]]...\n";
+            + COMMAND_WORD + " [n/[keywords]] [p/[keywords]] [e/[keywords]] "
+            + "[a/[keywords]] [t/[keywords]] [i/[keywords]] [pr/[keywords]] [r/[keywords]]\n";
     private static final Logger logger = LogsCenter.getLogger(FindCommand.class);
     private final PersonContainsKeywordsPredicate predicate;
 

diff --git a/src/main/java/seedu/address/logic/commands/RemarkCommand.java b/src/main/java/seedu/address/logic/commands/RemarkCommand.java
@@ -25,7 +25,7 @@ public class RemarkCommand extends Command {
     public static final String MESSAGE_DELETE_REMARK_SUCCESS = "Removed remark from customer: %1$s";
     public static final String MESSAGE_USAGE = "Usage: \n" + COMMAND_WORD
             + " <index> "
-            + "<remarks>\n";
+            + "[remarks]\n";
 
     private static final Logger logger = LogsCenter.getLogger(RemarkCommand.class);
     private final Index index;