search

darkdestry-t / pe

0 stars 0 forks source link

Inconsistency in command capitalization #7

Open darkdestry-t opened 3 years ago

darkdestry-t commented 3 years ago

Inconsistency seen in examples and command action name in Command Summary section of UG

Putting this as high severity as the command findPool is not case insensitive and is listed as example. Using the example results in Unknown command error.

image.png

image.png

nus-pe-bot commented 3 years ago

Team's Response

Dear tester, Thank you for finding this error. We have decided to accept this bug, however, we have decided to downgrade this to a "Low" severity bug as it is merely just a documentation bug typo within the command summary. The documentation at the UG features section is accurate and the user should be able to use the product with minor inconvenience.

image.png

image.png

Approaching from the perspective of a user, when he/she realizes that the example is wrong, they would go to the features section to further clarify.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: Given your argument, I am keen to accept that it is of severity Medium instead of low, given that there is a workaround. If a user encounter an erroneous example, it may indicate that the documentation is wrong. An expert user may choose to skip the features section entirely and jump straight to the command summary. This is further aggravated by the fact that your help menu contains the same error as seen in the screenshot below.

image.png

As a user, any mistake in the examples given would give rise to doubt of the accuracy of the documentation as a whole.