nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

DG missed out implementation of Add Transaction and View Transaction #1088

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.


Justification : These two features are main features of your app, there is a need for developer to refer it constantly in order to understand the architecture since from your code, these Transaction feature directly change the project structure majorly, hence is severity medium

Expected : Add uml diagram for these two features, or at least add transaction, so that the main structure able to explain to developer on what changes caused by this feature.

(it is a really good feature and i really think should add in to help developer to understand your project structure well, else i rely on reading code which is quite tough)


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

linnn-7 commented 2 months ago

Team's Response

Thank you for your feedback. However, we believe that we have sufficiently explained the implementations of adding and viewing transactions. These features are analogous to the add and find commands as described in the Model component of the Developer Guide (even much simpler implementations). The implementations of add and find commands are thoroughly elaborated in the Developer Guide. Additionally, it's important to minimize unnecessary overhead, and our documentation aims to provide just enough guidance to facilitate understanding and usage. While we appreciate the suggestion to include UML diagrams for these features, we believe that the clarity and simplicity of our code make such diagrams unnecessary.

Duplicate status (if any):

--