search

Yttruire / pe

0 stars 0 forks source link

Inaccurate error message for `Game` command without flags #6

Open Yttruire opened 2 years ago

Yttruire commented 2 years ago

CLI Input: game

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 error message also suggests that a game flag was input when it was not, which can be confusing.

nus-pe-bot commented 2 years ago

Team's Response

Rationale

Both issues deal are suggesting more descriptive error messages for similar commands.

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: This issue does deal with more descriptive error messages for commands of similar format, but not the same command, and should not be regarded as duplicate bugs.

Under the "General" section for "Guidelines for bug triaging":

image.png

1) The bug is not exactly the same (Different commands)

2) They are not from the same defect and can be fixed independently (Due to being different commands with different implementations)

3) It is not a diagram and this does not apply

Similar errors for different features are still separate bugs, so I do not agree that this report is a duplicate.

:question: Issue type

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

Reason for disagreement: Similar to the disagreement on DocumentationBug vs FunctionalityBug for the Friend command:

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

image.png

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.