search

ziyi105 / pe

0 stars 0 forks source link

Missing explanations on Ui and Model #18

Open ziyi105 opened 9 months ago

ziyi105 commented 9 months ago

image.png

Perhaps you should at least add a class diagram to describe them?

nus-se-script commented 9 months ago

Team's Response

Thanks for highlighting this. The team does know of this and we had no plan to explain these components in the DG due to how simple those components were, hence we felt that no further in depth explanation was needed. The description shown in this image exactly explains the role of data and UI. Since CLI is used, the UI component is simply used for printing to CLI only and nothing more.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: While I agree that Ui is very simple, I feel that the description can be a little bit more detailed as the current description hardly contains any information. They assume that everyone knows what a user interface is and every Ui in java application has the same structure. A more descriptive explanation can be "Responsible for taking in user input and printing output to the user through CLI"

For model, the description is again very abstract. It says "holds the data of the app in memory", so isnt that the role of a storage or data component? The meaning of memory is quite ambiguous to me as well, is memory something that will be kept even after the user exits the app or will it be erased? In the DG, model is only referenced once (shown below) and apparently mealListis part of the component. That's when I finally sort of had an idea what is a "model". I feel that the team should at least list down what kind of "data" (mealList, workoutList etc.) is under model.

image.png

After reviewing, I would lower the severity to medium.