Skip to content

Unnecessary sequence diagram (and unnecessarily long) #2344

Open
@nus-se-script

Description

@nus-se-script

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.



The given sequence diagram for the Ui methods appear to be unnecessarily verbose and long for readers (extending to more than 1 page just for the diagram). Breaking it down and explaining it method by method would be more appreciated.

image.png

Even if someone somehow finds this diagram readable, there are still notation errors found throughout. The errors are attached below:
The non-existent User class:
image.png

The non-existent activation bar:
image.png


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

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions