search

nus-cs2103-AY2223S2 / pe-dev-response

1 stars 0 forks source link

Class diagram for logic component is unclear regarding the Logic interface #15

Open nus-pe-bot opened 1 year ago

nus-pe-bot commented 1 year 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.

The class diagram used to describe the Logic component is unclear. Namely, the interface Logic is not implemented by LogicManager, or any other classes. Neither is it a dependancy of any other class.

image.png

[original: nus-cs2103-AY2223S2/pe-interim#15] [original labels: severity.Low type.DocumentationBug]

9fc70c892 commented 1 year ago

Team's Response

CAUSE:

This is a mistake made when AUTOM8 Development Team was learning how to use Plant UML for the first time (which was not formally taught).

Development Team initially dismissed this as PUML limitations. But upon further inspection of this issue based on this report, the team realized that Plant UML implicitly sets Package names as a label which caused this error to occur.

This is caused due to lack of PUML training and the team apologizes.

Duplicate status (if any):

--