Merge pull request #336 from AY2223S1-CS2103T-W16-4/update-ug-thomas

Update userguide
AY2223S1-CS2103T-W16-4 · Nov 6, 2022 · 4bc8159 · 4bc8159
2 parents 0e334e3 + ffd4329
commit 4bc8159
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 6 deletions.
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -347,15 +347,19 @@ Shows the list of clients in MyInsuRec.
 
 A valid filter can also be applied to show a selected list of clients.
 
-Format: `listClient [pd/PRODUCT || b/BIRTHDAY]`
+Format: `listClient [pd/PRODUCT || b/PERIOD]`
 
-* A valid filter can be clients who have bought the product `PRODUCT` or clients whose birthday is in range `BIRTHDAY`.
+* A valid filter can be clients who have bought the product `PRODUCT` or clients whose birthday is in range `PERIOD`.
 * `PRODUCT` must exists already.
-* `BIRTHDAY` is specified by keywords. The possible keywords are:
+* `PERIOD` is specified by keywords. The possible keywords are:
   * `tomorrow` for a list of clients whose birthday is tomorrow;
   * `week` for a list of clients whose birthday is in the next week;
   * `month` for a list of clients whose birthday from the start of the respective month to the end of the respective month.
 
+<div markdown="span" class="alert alert-info">**:information_source: Note:**
+The valid inputs for `b/PERIOD` differs from that of `b/BIRTHDAY`! `b/PERIOD` can only accept keywords, while `b/BIRTHDAY` can only accept specific dates. 
+</div>
+
 Use case:
 1. You want to find out all your clients with upcoming birthdays so that you can prepare ahead and ensure that every client gets some birthday well wishes!
 2. You want to identify the number of clients who purchased a particular product for analytics reasons.
@@ -368,8 +372,11 @@ Examples:
 * List all clients with their birthdays in the next week
   * `listClient b/week`
 
-<div markdown="span" class="alert alert-warning">**:exclamation: Caution:** Both filters cannot exist simultaneously.
-A user can only apply one filter at each time. For example, `listClient pd/Product1 b/week` is strictly not allowed.
+<div markdown="span" class="alert alert-warning">**:exclamation: Caution:**
+
+* Both filters cannot exist simultaneously. A user can only apply one filter at each time. For example, `listClient pd/Product1 b/week` is strictly not allowed.
+
+* Extraneous parameters will not be taken into account. For example, `listClient n/Alex` will be considered as `listClient` without any error messages.
 </div>
 
 #### 7.1.3 View client: `viewClient`
@@ -505,6 +512,11 @@ Examples:
 * List meetings happening in the next week
     * `listMeeting d/week`
 
+<div markdown="span" class="alert alert-warning">**:exclamation: Caution:**
+
+* Extraneous parameters will not be taken into account. For example, `listMeeting n/Alex` will be considered as `listMeeting` without any error messages.
+</div>
+
 #### 7.2.3 View meeting: `viewMeeting`
 
 View details associated with a meeting, such as the meeting's date and time, as well as the client's details associated with the meeting.

diff --git a/src/main/java/seedu/address/logic/commands/ListClientCommand.java b/src/main/java/seedu/address/logic/commands/ListClientCommand.java
@@ -19,7 +19,7 @@ public class ListClientCommand extends Command {
 
     public static final String COMMAND_WORD = "listClient";
     public static final String MESSAGE_SUCCESS = "Listed all clients";
-    public static final String MESSAGE_USAGE = "Usage: listClient OR listClient pd/PRODUCT OR b/PERIOD";
+    public static final String MESSAGE_USAGE = "Usage: listClient OR listClient pd/PRODUCT OR listClient b/PERIOD";
 
     private final Object object;