search

nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

No warning of using PlantUML #4460

Open nus-se-script opened 7 months ago

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

There is no warning that the image is inaccurate as a result of using PlantUML and that by right after the cross marker the lifeline should be cut off as well.

This is in every UML diagram and will heavily confuse readers on the implementation.

[original: nus-cs2103-AY2324S1/pe-interim#3425] [original labels: type.DocumentationBug severity.High]

mounilsankar commented 7 months ago

Team's Response

We did provide a warning for the first instance of a sequence diagram in the dg but we failed to provide the reminder again for the subsequent diagrams. This was because we did not want to repeat the same information over and over. The below screenshot shows the warning message.

Screenshot 2023-11-19 at 12.16.46 AM.png

This is certainly not a high severity issue. We believe that this is a cosmetic issue and hence veryLow as it is simply a good to have warning for each sequence diagram but we did not prioritise this in this version. Even if the developer reading the diagram did not know of the limitation of plantuml he/she would not change their implementation of the various methods because of this since Java does not require memory allocation and the dereferencing of objects after use

Duplicate status (if any):

--