search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Limitation of plantuml is not mentioned #4265

Open nus-pe-bot opened 2 months ago

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

Screenshot 2024-04-19 at 5.30.53 PM.png

there should be a note that there is a limitation of the uml diagram that the lifeline of the function extends until the end of the diagram. Without it, the X in your diagram is not defined and the extension of lifeline is 'incorrect'.

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

Joseph31416 commented 2 months ago

Team's Response

Hi! This thread is relevant to the issue: https://github.com/nus-cs2103-AY2324S2/forum/issues/944

Essentially, we can reuse the "X" notation as it is a standard UML notation in the textbook.

In addition, we have warned the user about the limitation of the UML diagram. Below is a warning under the DeleteCommandParser for the Logic component in our DG:

image.png

As this limitation is universal, we decided not to repeat it for every single UML diagram that involved the issue, since what is important is that the developer is informed the first time, and the omission of the warning subsequently does not cause any non-cosmetic problems for the developer (and it may actually hinder them more/cause an annoyance if we keep warning them over such a minor limitation).

However, we understand your concern as you did not have enough time to read the DG in detail, and therefore we will consider including a link to the warning for every UML diagram that has the dotted line limitation in the future. Hence, we will mark this as NotInScope instead of Rejected. Thank you!

Duplicate status (if any):

--