Branch v1.4 Update UG #186
Merged
Conversation
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
billyhoce
requested changes
Apr 15, 2024
| * **Member Orders Panel**: When you select a member, this panel will show all their past orders including the date, items purchased, and the points earned from each order. | ||
| * Update on Selection: The panel updates to show a member's orders only when a new member is selected from the Member List Panel. | ||
| * Re-Selection for Refresh: To view updated order information following a change (like a new order addition), you must re-select the member. | ||
| * Persistent Display: If a member is deleted or all data is cleared, the Member Orders Panel may still show the last viewed order history until a new member is clicked or the application is refreshed. |
| @@ -167,12 +205,15 @@ Members are classified into tiers based on their accumulated membership points. | |||
| - Example: `[ag/ALLERGEN]...` can be used as ` ` (i.e., 0 times), `ag/GF`, `ag/GF ag/LF`, etc. | |||
| - **Parameters can be in any order**. | |||
| - Example: If the command specifies `n/MEMBER_NAME hp/MEMBER_PHONE`, using `hp/MEMBER_PHONE n/MEMBER_NAME` is also acceptable. | |||
| - **Repeat parameters** (Except for [allergens](#6-glossary)) is not allowed and will result in an error. | |||
| - **Repeat parameters** (Except for allergens) is not allowed and will result in an error. | |||
There was a problem hiding this comment.
Change to:
Repeat parameters will result in the last occurrence being taken
- Example:
addpts n/John p/100 p/200will add 200 points to John - Exception: The addmem command will give an error if repeat parameters exist to help you make sure that you did not make a mistake!
docs/UserGuide.md
Outdated
| - **Extraneous parameters for commands that do not take in parameters** (such as `help`, `list`, `exit`, and `clear`) will be ignored. | ||
| - Example: If the command specifies `help 123`, it will be interpreted as `help`. | ||
| - **When using a PDF version of this document**, be careful when copying and pasting commands that span multiple lines, as space characters surrounding line-breaks may be omitted when copied over to the application. | ||
| - **If there is a repeat parameter**, only last parameter will be taken | ||
| - Example: `delitem i/chocolate croissant i/kaya waffle` will only delete kaya waffle from the catalogue. | ||
| - **For commands that accept partial names**, the system matches the input to the member whose name most closely resembles the provided partial name. If the partial name could refer to multiple members, the system will select the first member listed. | ||
| - To minimize confusion and errors, it is strongly recommended to use unique, full names of members when issuing commands. This practice also helps prevent duplicating member entries with similar names. | ||
| - Example: If there are members named `Betsy Crowead` and `Betsy Croweas`, and you issue a command for `Betsy Crowe`, the system will apply the command to the first `Betsy Crowe` listed in the member directory. |
There was a problem hiding this comment.
Maybe example can change to Betsy Crowe and Betsy Dredge, and the command is issued for Betsy
docs/UserGuide.md
Outdated
| </div> | ||
|
|
||
| <div style="border: 1px solid #DBAE58; margin: 10px 0; padding: 10px; background-color: #FFF3E0; color: #886B00; border-radius: 5px;"> | ||
| 💡 <strong>Tip:</strong> Use the `-c` flag (`help-c`) to show you a list of all the commands available in this application without opening an external link! |
| @@ -225,35 +273,51 @@ Format: `addmem n/MEMBER_NAME hp/PHONE e/MEMBER_EMAIL a/MEMBER_ADDRESS [ag/ALLER | |||
| - PF: Peanut-Free | |||
| - SF: Soy-Free | |||
| - CF: Casein-Free | |||
| <div style="border: 1px solid #D1478C; margin: 10px 0; padding: 10px; background-color: #FDE4EF; color: #910D47; border-radius: 5px;"> | |||
| 🧁 <strong>Benefit:</strong> The purpose of including allergens is to allow you to keep track of the allergies and dietary requirements of your customers. This is so that you can warn your customers when they order an item that contains their allergens or take note of it when customising on order. Nevertheless, this is an optional field that you may omit if you find uncessary. | |||
| </div> | |||
docs/UserGuide.md
Outdated
| </div> | ||
|
|
||
| <div style="border: 1px solid #FFA500; margin: 10px 0; padding: 10px; background-color: #FFE8B2; color: #CC6C00; border-radius: 5px;"> | ||
| ⚠️ <strong>Warning:</strong> You are strongly recommended to only use points less than 1000 to ensure the total points/membership points a member has remains within the safe range of 1…2,000,000,000. |
There was a problem hiding this comment.
hmm maybe can remove the 1000, or change to a larger number 10000? Still need 2 million orders of 1000 points to hit the 2 billion
docs/UserGuide.md
Outdated
| </div> | ||
|
|
||
| <div style="border: 1px solid #FFA500; margin: 10px 0; padding: 10px; background-color: #FFE8B2; color: #CC6C00; border-radius: 5px;"> | ||
| ⚠️ <strong>Warning:</strong> You are strongly recommended to only use quantities less than 100 to ensure the total points/membership points a member has remains within the safe range of 1…2,000,000,000. |
There was a problem hiding this comment.
Don't think need to mention the 100. Instead we should mention that quantity itself should not exceed safe range of 2,000,000,000
docs/UserGuide.md
Outdated
| </div> | ||
|
|
||
| <div style="border: 1px solid #FFA500; margin: 10px 0; padding: 10px; background-color: #FFE8B2; color: #CC6C00; border-radius: 5px;"> | ||
| ⚠️ <strong>Warning:</strong> Ensure that the total number of points/membership points a member has remains within the safe range of 1…2,000,000,000 so that the program does not malfunction. |
There was a problem hiding this comment.
I think should be 0...2,000,000,000 (Fix for all occurrences!)
kinjalagarwal1810
merged commit 5f1c4ad
into
AY2324S2-CS2103T-T13-4:master
3 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.