IronBiscuit / pe

0 stars 0 forks source link

Different descriptions of commands in UG and DG #8

Open IronBiscuit opened 3 years ago

IronBiscuit commented 3 years ago

image.png

The image above is from the User Guide, section 3.10.3 Filter by description: filter-d, while the image below is from the Developer Guide, section 6.12 Filter by Description.

image.png

In the UG case, the command is depicted to display expenses with descriptions that "contains" the keyword specified.

E.g "enter", "tainment", "entertain" are valid keywords for an "entertainment" description.

Whereas in the DG case, the command is depicted to display expenses with descriptions that "strictly matches" the keyword specified.

E.g "entertainment" is the only valid keyword for an "entertainment" description.

After using the application, it is apparent that the DG's description is the accurate one. Perhaps the UG could be editted a little to make the command description a little clearer.

nus-se-bot commented 3 years ago

Team's Response

The word "contains" is correctly used for UG, because what we mean is when user has the expense called A, with description: entertainment movie and he uses the command: filter-d entertainment, will list out the expense A. The reason is because description of expense A "contains" entertainment.

Perhaps, we have not specified well enough in UG that if the desciption of expense is separated by spacing, it will considered 2 kinds of keyword for DESCRIPTION. Our team accepted this issues with low severity

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.Low] Originally [severity.High]

Reason for disagreement: [replace this with your reason]