nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Architecture diagram: No arrows pointing to Commonss #3500

Open nus-se-script opened 2 months ago

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


common no arrow.png

Commons is used by other components but there is no arrows/ dash arrows


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

wang-xinrong commented 2 months ago

Team's Response

Quoting the textbook

image.png

There is no requirement for all dependencies to be captured by the architecture diagram. Especially in our case, omitting the dependencies arrows between the commons component to all other classes (since they all use utility class from commons) makes the diagram clearer.

Duplicate status (if any):

--