yleeyilin / pe

0 stars 0 forks source link

User guide do not have explain the restrictions on commands clearly #14

Open yleeyilin opened 2 months ago

yleeyilin commented 2 months ago

Below is a screenshot of your user guide:

image.png

Expected / Possible Improvements: LIST should not be a valid command format. However, this constraint is not written in the UG. This should be written to ensure that your reader / user will not be confused as to why their commands are not working.

image.png

soc-se-bot commented 2 months ago

Team's Response

The team thinks it is obvious that if a command is not listed in the UG, it isn't a valid command.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: list is a valid command since it is in your UG. What I meant by "not a valid command format" refers to the fact that the command is capitalised. It should have been written that the commands are case sensitive in your UG.

image.png