Page 9 Sequence Diagram: Could omit function parameters

[LimHongYao]

The inclusion of function parameters is arguably not necessary, especially as the long text causes the whole sequence diagram to be shifted to the right, affecting readability especially for ref blocks. It could probably be omitted entirely to preserve readability, or perhaps if required, the parameters could be noted down seperately from the main sequence diagram

[nus-se-script]

Team's Response

Removing the parseUserCommand's parameters does not affect the readability as it is just shifting of the block diagram to the right, we believe preserving parameter adds more value to allow the readers to understand what parameters Parser is making sense of.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

• [x] I disagree

Reason for disagreement: I maintain that readability has been affected as the text in the ref blocks overlaps with the diagram in general.

Additionally, I believe it is not a requirement for the function parameters to be included in the sequence diagram according to the textbook:

I think clarification is needed with regards to how the function parameters aid in understanding the sequence diagram, as I believe its omission is unlikely to affect understanding since the stated parameters are generally not used in the rest of the diagram.

---