nus-cs2113-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Add Income command format differs from UG but still works #124

Open nus-pe-bot opened 2 weeks ago

nus-pe-bot commented 2 weeks ago

In the UG, the command format for adding an income is given as follows:

add income DESCRIPTION a/AMOUNT [d/DATE]

This means that only if the command starts with add income, then the command will be parsed and executed. However, when tested with add incomes, the command was still executed as per normal but this was no where stated in the UG.

Steps to reproduce bug:

  1. enter add incomes salary a/54321
  2. The program shows that the expense was successfully added (see screenshot below), even though the keyword of the command contained an extra "s".

Sample Output:

Screenshot 2024-11-15 173559.png


[original: nus-cs2113-AY2425S1/pe-interim#235] [original labels: severity.Low type.FunctionalityBug]

telferang commented 2 weeks ago

Team's Response

124 and #700 are the same bug because we failed to mention in UG that add expense and add income command are able to handle commands with additional characters at the end of command key word.

We intentionally make this design choice to help prevent user frustration by tolerating minor input errors, thereby improving the overall user experience.

Initially, we feel that the UG should not exhaustively list minor permissible variations, as doing so could unnecessarily complicate the documentation. However, we agree that the UG should make it clearer by mentioning the program will still execute commands successfully even if they mistakenly add an 's' or make similar small errors.

We do not think that this is a FunctionalityBug as it does not impact the user ability to add income. In fact it makes it easier to add an income.

Duplicate status (if any):

Duplicate of #700