search

AY2425S1-CS2103T-W14-3 / tp

Other
0 stars 5 forks source link

[PE-D][Tester D] List command in the user guide is very vague and adds no value to the user #206

Closed nus-pe-bot closed 3 weeks ago

nus-pe-bot commented 3 weeks ago

Currently, the list command in the user guide shows the following:

image.png

The command description has no outputs or screenshots to show the user what is the expected output of the command, which does not add much value to the user reading the user guide and knowing what to expect for when they actually run the command.

An improvement would definitely be to first add a screenshot of the command output, and also mention that it will show all the members in the application even if previously there were no members shown (i.e. from a previous command output)

Labels: severity.Low type.DocumentationBug original: sayomaki/ped#12

keithxun commented 3 weeks ago

I dont think theres anything wrong with this tbh