search

1simjustin / pe

0 stars 0 forks source link

Inaccuracy of formatting of class diagram for `Parser` #15

Open 1simjustin opened 5 months ago

1simjustin commented 5 months ago

image.png

The Command interface is described using both the interface keyword and being italacised. However, according to the textbook, italacisation is meant to be used to denote abstract classes instead (see below).

image.png

nus-pe-bot commented 5 months ago

Team's Response

agree

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: Very Low severity is reserved for purely cosmetic bugs, with the textbook noting it as A flaw that is purely cosmetic and does not affect usage e.g., a typo/spacing/layout/color/font issues in the docs. This does not satisfy the requirement for Very Low, as it incorrectly represents a class as something that it is not, which would affect readers' understanding of the diagram by introducing inaccuracies.