Skip to content

Confusing class diagram #2455

Open
Open
@nus-pe-bot

Description

@nus-pe-bot

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

It says here that this is a class diagram for a method(?). I assume that this is the class diagram for Parser class as mentioned. Also, no clear arrowhead on the label to show direction its supposed to be read. Are we to assume that it is in the same direction as the navigability arrowhead? Additionally, it seems that its a class diagram for Parser class but the Parser class itself is missing from the diagram.

Overall, the diagram is confusing, I do not know what it is trying to show exactly. Does not fulfil its purpose, hence, high severity.


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

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions