search

paturikarthik / pe

0 stars 0 forks source link

Inconsistency in command conventions #4

Open paturikarthik opened 2 months ago

paturikarthik 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/"

soc-se-bot 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

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I believe that the command "inflow" and "outflow" are already clear in suggesting that the quantity specified will be the quantity to be changed and not the total quantity after the change. Even so, "a/" is still not an appropriate flag that suggests/represents change in quantity. Perhaps "i/" for inflow and "o/" for outflow would be more indicative. However, "q/" would definitely be the clearest and cause the least amount of confusion among users.

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** I do not agree with the severity.veryLow as this is not a cosmetic issue, but a bug that can cause users minor inconveniences.