leezhengjing / pe

0 stars 0 forks source link

Functionality: After running an untake command, expected screen (from UG) is different from the actual screen. #4

Open leezhengjing opened 12 months ago

leezhengjing commented 12 months ago

To reproduce: untake 1

image.png

Same as the take command, after running untake 1, the next screen shown is:

image.png

However, this is different from the user guide, which shows this.

image.png

It would be more friendly to the user to show the screen as promised in the user guide, as there is the updated consumption and stock.

Functionality Bug: Behaviour differs from User Guide

image.png

nus-pe-script commented 11 months ago

Team's Response

Accepted but as veryLow severity and as a documentation bug.

We disagree that the bug is a functionality bug as what you tested in the app is the intended output. If it were a bug, It would be more of a documentation bug, perhaps due to unclear wording. We agree that we could have been more clear with the wording. We used the phrase "you will get the following result", and refrained from saying "as shown below, this is what happens after typing the command". We specifically used this phrasing as the screenshot was not meant to be a direct "after" of the command. We wanted to show a more meaningful screenshot, by showing the effect command has on the prescription details.

But we agree that there could have been more effective phrasings.

It would be of veryLow severity type as it is a "cosmetic change". The meaning of the sentence remains the same.

Items for the Tester to Verify

:question: Issue type

Team chose [type.DocumentationBug] Originally [type.FunctionalityBug]

Reason for disagreement: [replace this with your explanation]


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]