search

Kair0s3 / pe

0 stars 0 forks source link

UG documentation image does not match output for `help` #5

Open Kair0s3 opened 2 years ago

Kair0s3 commented 2 years ago

Example below is the actual output and the parts with red arrow or underline are the bugs.

image.png

First thing, comparing with the UG, the "You:" is missing.

image.png

Second thing is that no new line was found at the arrowed area for the image in UG.

image.png

Perhaps standardizing whether to have new lines for categorized commands for the help list?

soc-se-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]

Output of help command does not match UG

In the UG, it is specified the command in square brackets are optional.

bug1c.png

UG example on adding a food:

bug1b.png

The help output from the program, however, does not specify that MEAL_TYPE is an optional parameter, as shown below:

bug1a.png

Consider changing the output to [/MEAL_TYPE] for consistency with UG, and it would be great to provide a note to the user as well.

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

Their Response to the 'Original' Bug

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

Accepted. Since this is a cosmetic issue, I will change the tag as very Low

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: Although the classification of the bug is similar relating to the incorrect UG image output, however, the specified parts of the bug is different from the other issue ('Output of help command does not match UG') as theirs was pointing out the usage syntaxes which would be more crucial for readers and users (possibly a severity low) while mine is the "You:" prompt and the (possibly) inconsistent use of line breaks in the help format as shown in this issue which are mostly cosmetics. Hence, I believe this is a separate issue with verylow severity.

:question: Issue type

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

Reason for disagreement: I feel that this is more of a documentation bug than a functionality bug, since it was just that the UG was not updated with the most recent help output I assume.