search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Possible UML notation mistake in delete class implementation section of DG #1295

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.

Description

The screenshot below is potentially an unintended mistake in the UML diagram, since the activation bars and return arrows don't seem to match up. The text description which follow this diagram also does not give much detail on the workings of this interaction.

Screenshot

image.png

Reason for Severity

As the diagram and text fail to give the reader a good idea of this part of the implementation, it hinders the reader's understanding to a notable extent.

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

Jajared commented 2 months ago

Team's Response

Woopsie

Duplicate status (if any):

--