nus-pe-bot
commented
9 months ago Team's Response
As this is an error regarding the readability and usability of the Minimax sequence diagram for understanding how the algorithm works, it can be parked under the Minimax sequence diagram documentation issue.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Sequence Diagram for MiniMax algorithm
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 sequence diagram for the minimax algorithm does not properly follow the UML notation from class. For example activation bars should end after returning and self invocations need their own activation bars
Screenshot 2023-11-17 at 17.38.54
[original: nus-cs2113-AY2324S1/pe-interim#566] [original labels: severity.Medium type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
The minimax sequence diagram is an artefact from the PE-D where no bugs were reported. There exists several documentation bugs which can cause an annoyance and hinder the flow or cause confusion, hence a medium rating seems reasonable.
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)
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
## :question: Issue severity Team chose [`severity.Medium`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
Sequence diagram for minmax algorithm is very blur, and it appears that the return arrow is straight line instead of be dash lines.