search

woojiahao / pe

1 stars 0 forks source link

Repeating information that can be inferred from the sequence diagram #20

Open woojiahao opened 10 months ago

woojiahao commented 10 months ago

Information such as the initialization of classes and method calls in between can be inferred from the sequence diagram. Can focus more on corner case handling instead.

Screenshot 2023-11-17 at 17.24.57.png

nus-pe-script commented 10 months ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Lack of use of activity diagram instead of describing behavior

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 2023-11-17 at 17.27.17.png

This section could be better served with an activity diagram showing the different flows of the program, rather than simply textually describing it

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

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Thank you for pointing this out, however, we believe that the explanation is rather clear and a diagram is not needed even though it is a good-to-have. This can be improved in a future iteration.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: There is no real explanation for why this issue is a duplicate but to counter why this might not be a duplicate:

This report focuses on how duplicating information does not provide any additional information about the command or its execution but rather, clutters the overall readability and purpose of the DG. As such, this report focuses on an excess of information.

The issue that was marked as duplicated focuses on the lack of appropriate usage of diagrams in describing the behaviour mentioned in the text. As such, that report focuses on the lack of diagrams to convey information.

Thus, the two reports are to address different aspects of the DG and should not be considered as duplicates of one another.

## :question: Issue response Team chose [`response.NotInScope`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]