search

Nanxi-Huang / pe

0 stars 0 forks source link

Behaviour differs from the UG #6

Open Nanxi-Huang opened 3 years ago

Nanxi-Huang commented 3 years ago

Screenshot 2021-04-16 at 3.17.33 PM.png

the add example resulted an error from the app

nus-pe-bot commented 3 years ago

Team's Response

First of all, the issue is changed from a functionality bug to a documentation bug because it is found in our UG and not our application itself. Severity is also decreased from medium to very low because it is purely cosmetic and caused by conversion from our online UG to PDF version.

Issue cannot be reproduced using command given in UG.

It is possible that the copy and paste of the multi line string in PDF format left out a space between -a and John street. Our application enforces the space after the prefix in our commands.

The full command should be add -n John Doe -p 98765432 -e johnd@example.com -c Google -j HR Manager -a John street as seen below in an excerpt of the UG

image.png

It has been mentioned in the PE practical document that copying commands from the PDF may result in a different pasted text.

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.CannotReproduce]

Reason for disagreement: This bug can definitely be reproduced, just copy and paste the example command to add a contact from the UG into the application and the bug is shown.

Although it is mentioned in the UG that pasted commands may be affected by the PDF viewer, the example command is already wrong in format.

There is an extra : after 'add' which makes the command invalid.

The other examples only have : after the valid command examples.

I feel that this team is probably not being very honest with their response because they already know the valid command should be without the extra : but they still reject it as CannotReproduce. This bug can easily be reproduced and they should know it once they look at their own UG.

image.png

:question: Issue type

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

Reason for disagreement: According to CS2103T website, a functionality bug is when behaviour differs from the User Guide. The user would assume that UG is accurate because the sole purpose of UG is to teach users how to use this product. In this case, the behaviour of the app is not accepting the command as suggested by the UG. In addition, this example command is under the Quickstart Guide of the UG, so it is before the user even starts learning the correct format to add a contact, and hence might cause more confusion.

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Medium]

Reason for disagreement: [replace this with your explanation]