LWachtel1 / pe

0 stars 0 forks source link

Insufficient number of sequence diagrams in DG #14

Open LWachtel1 opened 2 months ago

LWachtel1 commented 2 months ago

Only one sequence diagram for overall program has been provided.

image.png

More sequence diagrams would be appreciated to accompany the text descriptions of each component implementation, especially when those components consist of multiple classes. This would visually demonstrate program flow.

nus-pe-bot commented 2 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]

Insufficient class diagrams

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.


More class diagrams could have been added in the DG. Some class diagrams to add could be one that shows the overall structure and relationship between all the different classes, or the relationship between the parent and child classes (for Game, TicTacToe, and Hangman).


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

Their Response to the 'Original' Bug

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

No details provided by team.

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: I have specified sequence diagrams to show class and object interactions during program flow, whereas the other bug specifies only class diagrams to show more detailed structure. Hence, I do not consider these bugs to be duplicates, although the desire for addition to the DG is similar.