nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Conditions in sequence diagram #213

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.

Should the conditions be represented with "alt" instead? Returning true/false in the diagram might seem deterministic / misleading

_{[original: nus-cs2113-AY2324S2/pe-interim#244] [original labels: severity.Low type.DocumentationBug]}

HengShuHong commented 2 months ago

Team's Response

Implementing 'alt' for conditions may cause the sequence to be unreadable. In addition, the DG has stated that this sequence diagram is displaying a successful creation of a promotion and any unsuccessful creation will show an error message.

nus-cs2113-AY2324S2 / pe-dev-response

Conditions in sequence diagram #213

Team's Response

Duplicate status (if any):