search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

DG sequence diagrams wrongly labeled #1568

Open nus-se-script opened 2 months ago

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

image.png

image.png

image.png

image.png

The transactionList, memberList, and group are all illustrated in a way such that they return a value to the caller. But from the class diagram, it is interpreted that they return void when adding new items to the List.

[original: nus-cs2113-AY2324S2/pe-interim#1382] [original labels: severity.Medium type.DocumentationBug]

1simjustin commented 2 months ago

Team's Response

We accept this issue but have decided to lower the severity to Low as we feel it does not impede the readers' understanding of the program flow.

We feel that multiple bugs have been reported within this issue and have decided to omit the issue pertaining to group as it is trivial - getter methods do indeed have return values and have been omitted from the class diagram for brevity.

Duplicate status (if any):

--