maxxyh
commented
3 years ago Team's Response
Our inability to include the square brackets for the guards was due to us following the older syntax for activity diagrams (a.k.a. Activity Diagram - legacy), which did not support displaying the square brackets (we honestly tried different ways: [[double brackets]], "[quoted brackets]", [escaped brackets], ...), but these just resulted in syntax errors. The closest we could have achieved with this syntax was to include the opening square brace (see screenshot below), but this would have made the diagram look even tardier.
It was only after the PE that we discovered a newer syntax (a.k.a. Activity Diagram - beta), which does support including square brackets in the guards.
Regarding the missing merge nodes, as far as I know, merge nodes are optional and can be omitted so long as the it does not cause confusion in the diagram. Similarly for upper- vs. lower- case for actions, I am not aware of this requirement.
However, since these errors have clearly caused issues to the reader, we accept the bug report, but with Medium severity rather than High severity, since the diagrams are still clearly understandable.
Duplicate status (if any):
--
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.
All the activity diagrams in the DG do not have the branching condition with square brackets. Also, the actions do start with capital letters, and a lot of the branches have missing merge nodes. While individually I would mark them as Low, VeryLow and Medium respectively, but as these errors persist throughout several diagrams, I would mark this as a High.
Screenshots:
[original: nus-cs2103-AY2021S1/pe-interim#940]