Inconsistent notation: words in angle brackets are parameters

[E0735389]

In the UG it's stated

Words in angle brackets <> are the parameters to be supplied by the user.

But this notation is not followed throughout the document. This can cause confusion for the user, worst case typing in the capital letters literally.

[soc-se-bot]

Team's Response

Thanks for bringing up the issue.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Medium]

• [x] I disagree

Reason for disagreement: Compare with a known case in the textbook:

UML notation errors (e.g., using dashed line where a solid line should be used): When deciding the severity, consider how much the notation error hinders the reader, but also keep in mind that notation errors hurt the credibility of the diagram (i.e., if even the notation is incorrect, how much can be trust this diagram 🤔?). The latter pushes up the severity further than otherwise. So, the severity can be Low or higher.

In this case the notation is incorrect and it's not just cosmetic. Although it's true that the reader may interpret it correctly regardless, so hinder the reader is just a worst case scenario.

---