search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Wrong syntax for labels in UML class diagrams #2058

Open nus-se-script opened 4 months ago

nus-se-script commented 4 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.

Current Behaviour

This class diagram uses <<create>>, <<use>> for it's labels.

image.png

Expected Behaviour

According to this, labels should be of the form creates >.

As it is not mentioned that an alternative syntax is used in the developer guide, I put this as a documentation bug.

[original: nus-cs2103-AY2324S2/pe-interim#1711] [original labels: type.DocumentationBug severity.VeryLow]

Jerome-j commented 4 months ago

Team's Response

Thank you for your feedback.

We referenced the AB3 diagram which utilizes the same exact notations that you have mentioned, which is <<create>> and <<use>> labels. You may find the diagram here https://se-education.org/addressbook-level3/DeveloperGuide.html under the Parser Diagram.

We also wish to also note the issue that you have raised is for an Architecture Diagram - while the URL reference that you have kindly provided is for a Class diagram.

We appreciate your feedback on the matter.

Have a Nice day.

Duplicate status (if any):

--