search

Yttruire / pe

0 stars 0 forks source link

Inaccurate Error Message for `Friend` Command without Flags #3

Open Yttruire opened 2 years ago

Yttruire commented 2 years ago

CLI Input: friend

Expected output: Error message detailing that the flag is missing, rather than an unknown/incorrect flag has been input. It would be more convenient to tell the user what the format of a flag would be like as well, although this is a minor inconvenience (and thus low severity).

The expected output can be compared to the actual output of recommend:

image.png

Actual output:

image.png

This suggests that a friend flag was input when it was not, which can be confusing.

nus-pe-bot commented 2 years ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Error command unclear

image.png

To reproduce:

  • Enter friend --n

Result: "Unknown friend flag"

Flag is a specific term used in this context, and the user may not know what it refers to. The UG does not explain the term 'flag' as well. The error command could have been clearer, e.g., "unknown friend command -- please type --add, --edit, or ....."

[original: nus-cs2103-AY2122S1/pe-interim#5191] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

No details provided by team.

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: Under the "Guidelines for bug triaging", under "Functionality bugs" in the TP PE guide:

image.png

For the bug report that I have raised, it does include any issue with the UG, so I don't think mine can be grouped under DocumentationBug. Instead, the original bug that you're marking this as a duplicate of implies two separate bugs: Command error message should be clearer (FunctionalityBug) and UG does not explain what "flag" means (DocumentationBug).

If I'm not wrong, if you're accepting the original bug report as a documentation bug, then this bug report should be a separate bug report of a FunctionalityBug and not marked as a duplicate, since I do not detail the UG bug at all.

:question: Issue type

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

Reason for disagreement: Under the "Guidelines for bug triaging", under "Functionality bugs" in the TP PE guide:

image.png

As explained in the reasoning for why this should not be a duplicate as well, my report is entirely focused on FunctionalityBug, it does not detail any DocumentationBug and has no reference to the documentation (UG/DG). It is a bug that can only be fixed by changing the implementation of the feature in the application.