From 2d6d2eb2f0a9a170594440da1792f2f4e32758e4 Mon Sep 17 00:00:00 2001 From: yakultbottle Date: Mon, 11 Nov 2024 22:44:18 +0800 Subject: [PATCH 1/2] Rearrange User Guide to put Notes on top --- docs/UserGuide.md | 78 +++++++++++++++++++++++++---------------------- 1 file changed, 42 insertions(+), 36 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 1bcfeeef5c..0bb5b2a5be 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -3,7 +3,11 @@ **Version 2.0** 1. [Introduction](#introduction) -2. [Features](#features) +2. [Important Note](#important-note) + - [Case Sensitivity](#case-sensitivity) + - [No special characters](#no-special-characters) + - [Expiry Date](#expiry-date) +3. [Features](#features) - **General Commands** - [Viewing Help: `help`](#viewing-help-help) - [Listing All Items: `list`](#listing-all-items-list) @@ -35,10 +39,6 @@ - [Fulfill Order: `fulfill-order`](#fulfill-order-fulfill-order) - [Viewing Transactions: `transactions`](#view-transactions-transactions) - [Viewing Transaction History: `transaction-history`](#view-transactions-within-a-set-time-period-transaction-history) -3. [Important Note](#important-note) - - [Case Sensitivity](#case-sensitivity) - - [No special characters](#no-special-characters) - - [Expiry Date](#expiry-date) ## Introduction @@ -55,6 +55,39 @@ Key features: PILL is designed for users who prefer keyboard-based interactions over GUI applications, offering faster data entry and retrieval through CLI commands. + + +--- + +## Important Usage Notes + +### Case Sensitivity + +Our application is **case-sensitive**. This means that item names must match exactly as they were entered. For example: + +- `add Panadol` and `add PANADOL` will be treated as two different items. +- Similarly, commands such as `edit`, `delete` will only work if the case of the item name matches exactly as stored in the inventory. + +Ensure you use the correct capitalization when interacting with items in the inventory. + +### Order of arguments + +Our commands **do not** allow arguments in any order. Please read the documentation for the +order in which arguments should follow a command. + +### No special characters + +Our application **does not support special characters** for any input. + +Preferably, please keep to **lowercase, alphanumeric characters** for command inputs. + +### Expiry Date + +Under most commands, items with the same name but different expiry dates are treated as **different items**. Be very careful when reading command instructions: +- **Include the expiry date** with the item name for commands where it is required to ensure the correct item entry is processed. +- Always double-check the item's expiry date before executing commands like `delete` or `edit` to avoid unintentional modifications or deletions. + + ## Features @@ -89,8 +122,6 @@ Added the following item to the inventory: Aspirin: 100 in stock, expiring: 2024-05-24 ``` - - --- ### Listing All Items: `list` @@ -120,12 +151,13 @@ Listing all items: ### Deleting Existing Item: `delete` -The `delete` command is used to remove an existing item entry from the inventory. The behavior of this command depends on whether the item has an associated expiry date. +The `delete` command is used to remove an existing item entry from the inventory. The behavior of this +command depends on whether the item has an associated expiry date. **Format**: `delete NAME (EXPIRY_DATE)` - `NAME`: The name of the item you wish to delete. -- `EXPIRY_DATE`: An optional parameter in the `YYYY-MM-DD` format that must be provided if the item you want to delete has an expiry date. +- `EXPIRY_DATE`: An optional parameter in the `YYYY-MM-DD` format that **must** be provided if the item you want to delete has an expiry date. **Command Behavior**: @@ -212,7 +244,7 @@ Listing all items: **Notes**: -- The `find` command is not **case sensitive**. This means that `find PANADOL` and `find panadol` will yield the same results. +- The `find` command is **not** case-sensitive. This means that `find PANADOL` and `find panadol` will yield the same results. - Use `find` to quickly locate items, especially when you only remember part of the name. --- @@ -503,29 +535,3 @@ The system automatically saves any changes to the inventory to the hard disk aft Inventory data is stored in a `.txt` file (in `csv` format). Users can edit this file manually if necessary. - ---- - -## Important Note - -### Case Sensitivity - -Our application is **case sensitive**. This means that item names must match exactly as they were entered. For example: - -- `add Panadol` and `add PANADOL` will be treated as two different items. -- Similarly, commands such as `edit`, `delete` will only work if the case of the item name matches exactly as stored in the inventory. - -Ensure you use the correct capitalization when interacting with items in the inventory. - - -### No special characters - -Our application **does not support special characters** for any input. - -Preferably, please keep to **lowercase, alphanumeric characters** for command inputs. - -### Expiry Date - -Under most commands, items with the same name but different expiry dates are treated as **different items**. Be very careful when reading command instructions: -- **Include the expiry date** with the item name for commands where it is required to ensure the correct item entry is processed. -- Always double-check the item's expiry date before executing commands like `delete` or `edit` to avoid unintentional modifications or deletions. \ No newline at end of file From aa3509943acb50150e3639c06f6921df2a11be5f Mon Sep 17 00:00:00 2001 From: yakultbottle Date: Mon, 11 Nov 2024 23:13:25 +0800 Subject: [PATCH 2/2] Spring cleaning of unused files --- {src/main/java/seedu/pill/util => unused}/OrderItem.java | 5 +++++ {src/test/java/seedu/pill/util => unused}/OrderItemTest.java | 2 ++ {src/main/java/seedu/pill/util => unused}/TimestampIO.java | 5 +++++ .../java/seedu/pill/util => unused}/TimestampIOTest.java | 2 ++ 4 files changed, 14 insertions(+) rename {src/main/java/seedu/pill/util => unused}/OrderItem.java (97%) rename {src/test/java/seedu/pill/util => unused}/OrderItemTest.java (99%) rename {src/main/java/seedu/pill/util => unused}/TimestampIO.java (88%) rename {src/test/java/seedu/pill/util => unused}/TimestampIOTest.java (97%) diff --git a/src/main/java/seedu/pill/util/OrderItem.java b/unused/OrderItem.java similarity index 97% rename from src/main/java/seedu/pill/util/OrderItem.java rename to unused/OrderItem.java index 06d0f48a5f..af9a8b8385 100644 --- a/src/main/java/seedu/pill/util/OrderItem.java +++ b/unused/OrderItem.java @@ -1,3 +1,8 @@ +//@@author philip1304-unused +/* + * We ended up using regular Items in another ItemMap, rather than using a + * different type of item. + */ package seedu.pill.util; import java.time.LocalDate; diff --git a/src/test/java/seedu/pill/util/OrderItemTest.java b/unused/OrderItemTest.java similarity index 99% rename from src/test/java/seedu/pill/util/OrderItemTest.java rename to unused/OrderItemTest.java index c80b708060..9f49ce7135 100644 --- a/src/test/java/seedu/pill/util/OrderItemTest.java +++ b/unused/OrderItemTest.java @@ -1,3 +1,5 @@ +//@@author philip1304-unused +// Same reason given in OrderItem.java package seedu.pill.util; import org.junit.jupiter.api.Test; diff --git a/src/main/java/seedu/pill/util/TimestampIO.java b/unused/TimestampIO.java similarity index 88% rename from src/main/java/seedu/pill/util/TimestampIO.java rename to unused/TimestampIO.java index d01e936b49..a8d9eed243 100644 --- a/src/main/java/seedu/pill/util/TimestampIO.java +++ b/unused/TimestampIO.java @@ -1,3 +1,8 @@ +//@@author philip1304-unused +/* + * We did not get around to integrating timestamps since we had too many bugs + * in our code and many other features that needed integrating at the same time. + */ package seedu.pill.util; import java.time.LocalDateTime; diff --git a/src/test/java/seedu/pill/util/TimestampIOTest.java b/unused/TimestampIOTest.java similarity index 97% rename from src/test/java/seedu/pill/util/TimestampIOTest.java rename to unused/TimestampIOTest.java index 7e5ad7360f..203c8f0e83 100644 --- a/src/test/java/seedu/pill/util/TimestampIOTest.java +++ b/unused/TimestampIOTest.java @@ -1,3 +1,5 @@ +//@@author philip1304-unused +// Same reason given in TimestampIO.java package seedu.pill.util; import org.junit.jupiter.api.AfterEach;