search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

[DG] More clarity regarding the empty `Model` box #5393

Open nus-se-script opened 6 months ago

nus-se-script commented 6 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.

Hello!

This isn't a big concern at all, but I thought that the Model box on page 17 could be smaller, as I wasn't sure if it was empty by choice or due to a bug/forgot to put!

image.png

Thank you!

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

drustanyjt commented 6 months ago

Team's Response

Hi thanks for pointing this out!

This diagram is correct in that the model is supposed to be empty. This is the default size of an empty box in PUML (and specifying sizes of specific components is not easily done in PUML). The point of having the empty Model is to remind the developer that there is some interaction with Model, without going into the nitty gritty details of Model itself since the focus is on the UIPart.

We rejected the bug since there isn't really an alternative, and if you trust the author and take the diagram at face value it deliver the meaning we were intending to convey: "that there is some interaction with Model, without going into the nitty gritty details of Model itself since the focus is on the UIPart".

Duplicate status (if any):

--