search

nus-cs2103-AY2021S1 / pe-dev-response

0 stars 0 forks source link

DG logic diagram error #5949

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.

Logic interface should have a dependency arrow pointing to CommandResult? Like this Screenshot 2020-11-13 at 5.22.56 PM.png

But you diagram does not have this arrow

[original: nus-cs2103-AY2021S1/pe-interim#5935]

JoeyChenSmart commented 3 years ago

Team's Response

Thank you for the bug report.

Firstly, we will reduce the severity to Low instead of Medium. This is because it does not affect the information that is meant to be conveyed with the usage of this Class Diagram (Refer to explanation below the image).

image.png

Secondly, we will be rejecting this bug due to reasons explained below.

Strictly speaking, the Logic interface indeed has a dependency on CommandResult. However, since our diagram is much more complicated, we decided to omit this as adding the additional arrow will make the diagram more cluttered and much harder to read.

The focus of this diagram is to show the interactions of the classes within the logic component itself, and we decided to emphasize the interactions in the Parser, Command and Parameter, over how the logic component interacts with other components through its interface.

Duplicate status (if any):

--