Yttruire / pe

0 stars 0 forks source link

Symbols and syntax used does not explain any syntax used. #9

Open Yttruire opened 2 years ago

Yttruire commented 2 years ago

image.png

This section states that we can refer to the link for symbols and syntax used. Upon clicking the link, we get the following:

image.png

which only details symbols used. The only reference to syntax is the column title of the table, but shown are only symbols, not syntax.

nus-pe-bot commented 2 years ago

Team's Response

Rationale for downgrading

Its merely a typo and doesn't affect nor hinder the usage of the document.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: While it may be an unintended typo, I don't think that it is merely a cosmetic issue because the user expects to see details about both symbols and the syntax used when they click on the hyperlink labelled "symbols and syntax used". Because of this, there is a mismatch between user expectations and what the documentation actually provides, resulting in some inconvenience for the user, and a decrease in the quality of readability/understandability.

It may cause confusion "in rare situations and causes a minor inconvenience only", but that is the criteria for a severity.Low bug