daryltay415 / pe

0 stars 0 forks source link

Missing package #11

Open daryltay415 opened 2 months ago

daryltay415 commented 2 months ago

image.png

It seems that the class Florizz is not under any package in the sequence diagrams even though it is in a package. In addition, there are no packages with the named logic the source files.

nus-se-script commented 2 months ago

Team's Response

The boxes are illustration for general labelling for the overall program architecture and does not refer to a specific name of packages in the source code. This is to ensure our diagram is easily understood by reader.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: In the address book developer guide example, their architecture is similar to yours. However, the components that are labeled as logic, model and storage do exist in their source code. image.png

Hence, if readers were to look at the source code, they can easily verify that the diagram follows the source code. However, since the boxes are illustration for general labelling in your diagram, when readers look at your source code, they will have a hard time identifying where are the classes that belonged to logic or model. This makes it difficult for them to verify your diagram is accurate.


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** I do not think it is of very low severity as this diagram does reflect what the logic of your source code would be. If the labels are incorrect, it would give users a misunderstanding of how your program logic works.