search

nus-cs2113-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Command class diagram in the DG is extremely cluttered #243

Open nus-pe-bot opened 1 week ago

nus-pe-bot commented 1 week ago

Details: The class diagram in page 16 of the DG contains too many unnecessary methods in it, making the diagram hard to follow and understand. You could maybe consider omitting much of the methods from classes such as Ui and SpendingList, as their inclusion hinders the reader more than helps them in understanding the class diagram.

Screenshot: image.png

[original: nus-cs2113-AY2425S1/pe-interim#414] [original labels: type.DocumentationBug severity.VeryLow]

NigelYeoTW commented 1 week ago

Team's Response

Dear tester,

The team has discussed and decided to reject the bug. The following are the justifications:

  1. We have already omitted many methods and attributes in these classes. We feel that the remaining ones are significant and should be shown to a developer who is reading the guide to avoid confusion.

Duplicate status (if any):

--