search

medajet / pe

0 stars 0 forks source link

Command summary incorrectly formatted #13

Open medajet opened 2 years ago

medajet commented 2 years ago

"&vert" appears multiple times.

image.png

nus-pe-script commented 2 years ago

Team's Response

This should be a cosmetic issue as it does not affect the use of the documentation. Furthermore, under each description for the commands, the sample commands are correct and can be used.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: This issue is not purely cosmetic, as the extra terms in the command can outright cause confusion to the reader. Someone who is reading this section for the first time will likely be confused as to what they are reading. However, a case can be made for this issue to be Low severity instead, as the example below the command itself does present in the correct format.