teojunda / pe

0 stars 0 forks source link

Command format for add is unclear #7

Open teojunda opened 4 months ago

teojunda commented 4 months ago

Screenshot 2024-04-19 at 4.43.30 PM.png For the add command, the user guide indicates that tag may only be used once, since it does not contain ...

Screenshot 2024-04-19 at 4.44.26 PM.png

However, the add command allows for multiple tags to be included. eg. add --name=Jane Doe --phone=92933578 --email=janed@example.sg --addr=Amy street, block 123, #11-02 --tags=Disabled --tags=SeekingAssistance --note=NA

nus-se-script commented 4 months ago

Team's Response

For the add command, the user guide indicates that tag may only be used once...

Our user guide does not indicate that tag may only be used once. In fact, we have clarified and stated multiple times throughout the UG that there can be any number of tags per client.

The line right after the screenshot used says a client can have any number of tags (including 0).

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Though the add command allows the client to have multiple tags, this is not consistent with the command format, since the tag parameter (refer to image below) does not have the ellipses ... that indicates that it can be used multiple times. For it to be consistent, it should be [--tags=TAG].... Therefore, this inaccuracy confuses the reader and is a valid bug.

Screenshot 2024-04-23 at 4.06.04 PM.png


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** This is not a cosmetic issue. The inconsistency between the command format and the usage of the command can confuse the user.