search

jiakai-17 / pe

0 stars 0 forks source link

docs: unnamed variable is used in sequence diagram #13

Open jiakai-17 opened 9 months ago

jiakai-17 commented 9 months ago

docs: unnamed variable is used in sequence diagram

Affected Component(s)

[ ] Application [ ] User Guide [x] Developer Guide

Description

the result variable is used in the final returning arrow, but the diagram does not show what this variable name refers to

Screenshots, if any

image.png

Additional context / Potentially problematic behavior / Improvements

Reason for choosing severity level:

nus-pe-script commented 9 months ago

Team's Response

We decided to reject this issue as this theoretically is not incorrect according to the course website textbook:

image.png

In the textbook, gameState is returned even though it is not labelled as a variable anywhere in the UML diagram. We are simply following the convention used in the textbook and the omission of the variable anywhere else in the diagram does not hinder understanding or cause confusion.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]