Inconsistency with optional fields in edit_event in UG

[kaajinn]

In the user guide, it is stated that items in square brackets are optional:

However, under the edit_event command section of the UG, it is implied that the following are optional fields:

Yet under the given command format, they are implied to be compulsory fields:

Would it be better to include square brackets for the optional fields in the format to reduce user confusion?

[nus-se-bot]

Team's Response

Issue mentioned is a cosmetic flaw. The User Guide also says that one of the optional fields must be provided to make changes.

Items for the Tester to Verify

:question: Issue severity

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

• [x] I disagree

Reason for disagreement: Thank you for your response!

• However, as stated by the course website, a flaw is only cosmetic when it is a typo/spacing/layout/color/font issue. The example provided (lack of square brackets around ALL parameters) is neither of these things.
• While it is true that the "User Guide also says that one of the optional fields must be provided to make changes", this does not address the point about user confusion. One can also argue, based on the user guide format given, that the user guide says that all parameters are required, since there are no square brackets around the parameters.
• Thus, I believe the severity should remain as 'Low', rather than 'VeryLow', as it adheres to the description given by the course website, where this flaw is unlikely to affect normal operations, & causes a minor inconvenience only, and is also not a cosmetic flaw.

---