nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Missing colon for instance #783

Open nus-pe-bot opened 6 months ago

nus-pe-bot commented 6 months ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.


image.png

For this sequence diagram for identifying a student, the instance at the top is missing the colon, which would cause developers to not understand that it is an instance. This will cause developers to misunderstand the programme. Hence, I am assigning this a severity of medium.


[original: nus-cs2113-AY2324S2/pe-interim#717] [original labels: severity.Medium type.DocumentationBug]

Cryolian commented 6 months ago

Team's Response

It is in fact not an instance, but rather calling a class method. Regardless, it does not greatly hinder the user's ability to understand the diagram.

Duplicate status (if any):

Duplicate of #79