search

pipipipi2002 / pe

0 stars 0 forks source link

Syntax error for DG: Export #15

Open pipipipi2002 opened 1 year ago

pipipipi2002 commented 1 year ago

From the DG,

Screen Shot 2022-11-11 at 20.46.43.png

Export is an interface, as shown here Screen Shot 2022-11-11 at 20.47.25.png

Interface objects are represented using the angled brackets << >> and not in italics.

An example from the text book is this.

Screen Shot 2022-11-11 at 20.48.21.png

nus-pe-script commented 1 year ago

Team's Response

As it is a cosmetic issue, it is a bug but the severity level should be very low.

image.png

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: I disagree that this is merely a comestic issue as it involved the syntax that CS2113 is strictly using. Interface is one of those special UML diagram that has a specific syntax attached to it. Although I agree that it can be of a lower severity, it should be at least a medium since it is already taught in lecture and tutorial. Moreover, readers may not know whether your text or the diagram is the correct representation of the code, thus it should not be the case that there are inconsistencies in documentation. Especially developers might only skim through the object class diagram since it should tell them a basic idea of the class stucture.

Thus, severity should at least be a medium, instead of very low.