EricXiong420 / pe

0 stars 0 forks source link

Too much detail for AddFinance feature #17

Open EricXiong420 opened 11 months ago

EricXiong420 commented 11 months ago

Screenshot 2023-11-17 at 5.21.50 PM.png Not only does the text lay out every step in the process, so does the sequence diagram, making either redundant, while also including so much detail that it becomes difficult to read.

nus-pe-script commented 11 months ago

Team's Response

Thank you for your feedback :)

We acknowledge your views.

However, we would disagree with the idea that there are too many details. After all, this is meant to be an in-depth look into how Finance entries are added so that future developers/maintainers can understand the flow of the program, which is not always clear from the code.

Moreover, the sequence diagram is meant to be an augmentation of the explanation given in the text and can hardly be called "redundant". There is value in providing this visual aid.

We will be rejecting this issue.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]