search

weishuangtan / pe

0 stars 0 forks source link

Help Command expected output doesn't have to be printed in full. #13

Open weishuangtan opened 3 years ago

weishuangtan commented 3 years ago

image.png

The entire help command output is placed in the User Guide, which also lengthens the guide a lot. Perhaps just showing the first three rows of the output will suffice. Also, the Help Command itself is not aligned properly and makes it hard for users to navigate through the help list, as shown in the following:

image.png

nus-pe-bot commented 3 years ago

Team's Response

HI, thank you for raising this issue. I have set only one help message to enable new user to view all the feature available with its respective input. I am considering adding specific help message in future developments of the application.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Perhaps there is a misunderstanding. I was referring to solely the help command's expected output in the User Guide, and about how I personally feel it's a little lengthy considering that it's a duplicate of the User Guide itself. This is my suggestion as mentioned with a pictorial example for clarity:

image.png

:question: Issue type

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

Reason for disagreement: This is still a Documentation Bug since it is solely for the output on User Guide.