paturikarthik / pe

0 stars 0 forks source link

Incomplete Diagram for Storage Component #12

Open paturikarthik opened 2 months ago

paturikarthik commented 2 months ago

image.png

The diagram may potentially be cut off, or incomplete as Class from which the dependencies to TransactionStorage and Storage are omitted in the diagram. However, it is mentioned in the description that the Dependency is from StockPal.

nus-se-script commented 2 months ago

Team's Response

Hi there, thank you for the report.

Understand the fact that the diagram looks like it is cut off, or incomplete. However, this was on purpose, as we did not want to have repetitive details in the diagrams. In case you did not notice, the dependency of StockPal onto TransactionStorage and Storage was already in the Overall Architecture Diagram. As a developer reading the Developer Guide, you should have noticed this at the start, and when reading towards the Storage component, you would have already been aware of this fact. I have also attached the image of the Architecture Diagram below.

image.png

In addition, you have also mentioned that you could see that the dependency is from StockPal. As a result, we would like to argue that this is not a MEDIUM report.

Once again, thank you for the report!

Best Regards, StockPal Team

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: While I can infer that the storage component has a dependency from Stockpal, it is not clear for TransactionStorage. While it may seem like a nitpick, being clear in the DG is highly important as it helps future developers understand the app and its intricacies. As such, I believe this bug should not be rejected.


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** This is not a cosmetic issue, as such it is not a very low severity. Furthermore, this issue may leave doubts in the reader's mind. As such, this should be a medium severity bug.