search

nus-cs2113-AY2021S1 / pe-dev-response

0 stars 0 forks source link

Issue with sequence diagrams on page 15 of DG #1557

Open nus-pe-bot opened 3 years ago

nus-pe-bot commented 3 years 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.

When calling the constructor, there should be a small activation bar below, according to the lectures.The <> is not needed also. And there are no activation bars in the diagram

image.png

[original: nus-cs2113-AY2021S1/pe-interim#1407]

0xEljh commented 3 years ago

Team's Response

This is a valid diagram because it complies with minimal notation From the module textbook:

image.png Activation bars were omitted because all return arrows were included to make it unambiguious

The <<class>> marker for FoodManager was used because its static methods were called (it only contains static methods). Hence, the marker was used to make it unambigious that FoodManager is participating as a class.

Downgraded to very low as it does not affect usage and at most creates some ambiguity.

Duplicate status (if any):

--