search

nus-cs2103-AY2223S2 / forum

12 stars 0 forks source link

Bug if PlantUML notations used in diagrams? #377

Closed toh-xinyi closed 1 year ago

toh-xinyi commented 1 year ago

Is it a bug if PlantUML notations are used in UML diagrams which are different from what we were taught in class?

For instance, private attributes of a class would typically be noted by a - as taught in class but private attributes in PlantUML would be shown as blank red boxes: image

Related to issue #411 and #2390

damithc commented 1 year ago

@toh-xinyi Doesn't the AB3 DG use PlantUML too but follow the standard notation for member visibility?

toh-xinyi commented 1 year ago

@damithc Oh, I can't seem to find any examples in AB3's DG that shows the visibility of attributes in the UML diagrams

damithc commented 1 year ago

@toh-xinyi Good point. Nevertheless, it can be done, which means a deviation is not justifiable.

e.g., https://nus-cs2103-ay2223s2.github.io/website/se-book-adapted/chapters/designPatterns.html#singleton-pattern

image

toh-xinyi commented 1 year ago

@damithc Okay, noted. Thank you for your help prof!

toh-xinyi commented 1 year ago

@damithc Also, would this be a severity.High bug? Our tester reported it as high but I feel it would be a severity.Low bug since it would not hinder the reader to a large extent.

damithc commented 1 year ago

@toh-xinyi You can choose the severity based on how much the bug is expected to affect the reader, which depends on how important the visibility symbols are for the purpose of those diagrams.