search

blackmirag3 / pe

0 stars 0 forks source link

Slightly inaccurate architecture diagram #10

Open blackmirag3 opened 4 months ago

blackmirag3 commented 4 months ago

Screenshot 2024-04-19 at 5.32.11 PM.png

For the interaction between user and main BudgetBuddy class, is the arrow pointing to user supposed to be representing programme output for user to view? I believe this output is already represented by arrow from the UI class and this arrow could be extra.

nus-pe-script commented 4 months ago

Team's Response

Thank you for your suggestion. I do acknowledge that a reader might be confused as to why there is an arrow pointing back to the user from BudgetBuddy and should have provided more context as to why there is a bidirectional arrow from the User to BudgetBuddy.

Although most of the outputs are displayed to the User from the UI class, in particular, the welcome message, goodbye message, dividers and commands, BudgetBuddy actually does display certain outputs to the user too. One example of this is that BudgetBuddy displays the (invalid command) output if a user inputs an invalid command.

Here is the snippet in the BudgetBuddy code showing this

image.png

Given that this part was just to give a rough overview of BudgetBuddy before delving deeper in the classes and their associations, adding this extra context in this section was not of a higher priority as compared to the later parts of the DG, hence I classified this under NotInScope.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: [replace this with your explanation]