yucheng11122017 / pe

0 stars 0 forks source link

No help command for list and exit #13

Open yucheng11122017 opened 2 years ago

yucheng11122017 commented 2 years ago

Minor point but seems a bit odd that these commands are excluded from help.

image.png

nus-pe-script commented 2 years ago

Team's Response

list and exit commands do not require any fields/parameters for its usage.

Moreover, users will never see any error message when using list and exit commands, since commands such as list abc or exit 123 will still do the job. This is indicated under the "Standard Notation" section in the User Guide.

截圖 2021-11-14 下午4.14.05.png

Hence, we do not see a need to include in-app guidance for these two straightforward commands.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I don't think help is limited to being just about helping the user execute the commands. The user might also want to have additional information about what list and exit does or to double confirm that there is no additional usages that they can use for it and so on without going back to the documentation. Hence, this is still a missing feature. Also, it is quite easy to implement so not sure why the team decided to not do it.


:question: Issue severity

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

Reason for disagreement: Definitely not a cosmetic issue since there is a missing feature for these two commands.