nus-cs2113-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Mistakes in a DG sequence diagram #1229

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.


From top to bottom:

  1. Top of activation bar is missing
  2. alt hides activation bar of Finux
  3. If deleted, cannot return
  4. No line should be under an object deletion image.png

[original: nus-cs2113-AY2021S2/pe-interim#1229] [original labels: severity.High type.DocumentationBug]

marklowsk commented 3 years ago

Team's Response

Hi, let me address the issues raised:

  1. This is diagram image is generated solely by PlantUML, there may be some minor graphic changes after generating. The top of the activation bar is not missing, the color it is faint.
  2. "alt hides activation bar of Finux". This is not a bug, PlantUML generates the image like this, and this does not affect the meaning of the diagram.
  3. After throwing an exception, the object is destroyed. PantUML makes it difficult to destroy it a bit later without affecting the diagram. Therefore, this is still sensible.
  4. For the life line persisting after destroy issue, this is PlantUML's limitation.

image.png\ This was also mentioned in the DG.

Duplicate status (if any):

--