search

nus-cs2103-AY2021S1 / pe-dev-response

0 stars 0 forks source link

ViewTutorialGroupCommand Sequence Diagram involves too many low-level details #4973

Open nus-pe-bot opened 3 years ago

nus-pe-bot commented 3 years 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.

I believe that a lot of these low-level details can be abstracted away (no need to go deeper than UniqueModule List). This applies to the other sequence diagrams as well, but is especially apparent for this particular command.

image.png

[original: nus-cs2103-AY2021S1/pe-interim#4840]

euzintan commented 3 years ago

Team's Response

Thanks for the suggestion. The lower levels of the sequence diagram were intentionally not abstracted out as it is neccessary information for the reader to know. We intended for it to explicitly show which classes are involved in the method execution.

However we accept this as a formatting error because it may be difficult for the reader to comprehend. Hence the VeryLow severity.

Duplicate status (if any):

--