search

jiachen247 / pe

0 stars 0 forks source link

Lack of examples in UG #10

Open jiachen247 opened 4 years ago

jiachen247 commented 4 years ago

The UG only provides minimal examples. Would be good to include an example for every sub command.

Screenshot 2020-04-17 at 3.14.36 PM.png

nus-pe-bot commented 4 years ago

Team's Response

We feel that adding extra examples might increase clutter in the UG especially when the subcommands have very similar parameters.

Furthermore, despite not being elaborated in the UG, the usage of each subcommand has been integrated to the application. When users do not enter a valid command, the valid usage and a valid example of the command would have been displayed back to them.

We will downgrade this severity to low, as the lack of the other subcommand examples causes trivial inconvenience.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: While I do agree, that going overboard with this could be an issue there just wasnt enough commands to help a user start up! I spent alot of time figuring out and typing the commands which is somehting the UG is supposed to help with!

:question: Issue severity

Team chose [severity.Low] Originally [severity.Medium]

Reason for disagreement: See above ^