search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

incorrect class diagram #793

Open nus-se-script opened 5 months ago

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

The green c bubble to show that an item is a class is both unnecessary and incorrect. It is already a class by default without the bubble: other types are differentiated by <> or {abstract} already.

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

EugeneChanJiajun commented 5 months ago

Team's Response

The class symbol does not create any misunderstanding for readers so we do not feel that this is an issue.

Duplicate status (if any):

--