search

Tomashiwa / pe

0 stars 0 forks source link

Incorrect text to indicate the instantiation of AddReaderCommand and Reader #17

Open Tomashiwa opened 3 years ago

Tomashiwa commented 3 years ago

new Reader and newAddReaderCommand are all not valid syntax in creating a Reader or AddReaderCommand. They should be actual methods or constructors syntax.

image.png

nus-pe-bot commented 3 years ago

Team's Response

Similar to the example in the textbook, we employ minimal notation here to make the diagram more concise. In fact, the meaning of the sequence diagram is not affected nor ambiguous.

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The example quoted by the team does not apply to the team's diagram.

The omission mentioned in the example only applies to activation bars and return arrows, not the labelings. Furthermore, the newgame and newGame in the minimal sequence diagram of the example is not used to create an instance of TextUI or MSLogic, they are just regular functions.

image.png

On the other hand, the labelings we are discussing here are for constructors. The team should either omit the 2 labels entirely or give proper constructor syntax instead of what they have given here.

image.png

:question: Issue severity

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

Reason for disagreement: This incorrect labeling can cause confusion and miscommunication for future developers. Since it is not a visual issue and it can cause occasional inconvenience for the developers, the severity should remain Medium.