search

caitlinjee / pe

0 stars 0 forks source link

lack of specification that commands are case-sensitive #2

Open caitlinjee opened 4 years ago

caitlinjee commented 4 years ago

For commands where there is a letter in capital letters, such as listAll or enterDeck, and commands during review mode such as f and w, there is no indication in the user guide that the commands are case sensitive. Perhaps could add this note?

image.png

image.png

nus-se-bot commented 3 years ago

Team's Response

There were no mentions of case senstivity in the UG, hence users should exercise caution and follow what is stated in the UG instead of assuming otherwise.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: It is true that there are no mentions of case sensitivity for commands in the UG, which is why I considered this a documentation bug. It is possible that a user may not take note of their cases and run the commands in the wrong cases, then get confused as to why they are not working. So, I think that there should be a note in the UG stating that the commands are case sensitive, and that this is considered a documentation bug as the UG is lacking this information.

:question: Issue severity

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

Reason for disagreement: I feel that this issue can be considered medium. Users can continue to use the product, but without this information, some users might be confused as to why their commands aren't working if they aren't taking note of their cases used.

severity.Medium : A flaw that causes occasional inconvenience to some users but they can continue to use the product.