search

ZhangWenyue3325 / pe

0 stars 0 forks source link

Unclear User Guide for list feature #4

Open ZhangWenyue3325 opened 4 months ago

ZhangWenyue3325 commented 4 months ago

image.png The -t listType is confusing as users like me may not know what the types are, and there is no specific example given. Examples are given only for listing all and today, but not certain types. I have no idea what should I enter for -t. Does it mean -t is only for all and today?

soc-pe-bot commented 4 months ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Confusing listType Parameter

After thorough search from the User Guide, listType can only be either "all" or "today" which is not explicitly specified in the UG or the command message.

Screenshot 2024-04-19 170151.png

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

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Under the "Listing medications" section in the UG, there are only two commands, one is for "All medications: list -t all" and the other is "Daily medications: list -t today".

But yes, the help message should have stated that "list -t" only has "all" and "today", and no other variations for the listType.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

## :question: Issue type Team chose [`type.FunctionalityBug`] Originally [`type.DocumentationBug`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]