search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

UG output pictures are not user friendly #1188

Open nus-pe-bot opened 5 months ago

nus-pe-bot commented 5 months ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

The output pictures for the UG might be confusing for users as they do not look exactly like how they look in the cli interface. To make it clearer, you could show output pictures from the actual interface when using the application in order to show users what to expect.

image.png

[original: nus-cs2113-AY2324S2/pe-interim#1415] [original labels: type.DocumentationBug severity.VeryLow]

royaliceblue commented 5 months ago

Team's Response

The suggestion for how they look like in the CLI interface may be relevant if we were to show the example usage of the command with the output.

The purpose of the output section is to show the user what he/she should expect if the add command succeeded.

Since your original description pertains to the output message not looking exactly how they look in the interface, we would reject since the output message is as expected (what you will see upon a successful add command)

Duplicate status (if any):

--