search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Inconsistency in command conventions #485

Open nus-pe-bot opened 2 months ago

nus-pe-bot commented 2 months ago

image.png

While this may be a nitpick, it is rather confusing that the flag for quantity is sometimes "q/" and sometimes "a/"

[original: nus-cs2113-AY2324S2/pe-interim#553] [original labels: severity.Low type.FeatureFlaw]

Kobot7 commented 2 months ago

Team's Response

Hi there, thank you for your report.

Having different flags for the "Quantity" field is an intentional choice, as "Quantity" has different purposes in the different commands.

In the add and edit command, q/QUANTITY is used to specify the total quantity of the product. In the inflow and outflow command, a/QUANTITIY is used to specify the change in quantity of the product. Reusing q/QUANTITY for the inflow and outflow command may hence confuse users as to whether they are editing the total quantity of the product, or merely increasing/decreasing the amount.

We hope this clears up the design choice. Nevertheless, thank you for bringing up this concern.

Best Regards, StockPal Team

Duplicate status (if any):

--