Wrong symbol (square bracket used).

[nus-pe-bot]

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.

---

UG says Items in square brackets are optional e.g n/NAME [t/TAG] can be used as n/John Doe t/friend or as n/John Doe .

The it utilizes [ ] for "might not be optional field", which is not proper, and might cause confusion.

---

_{[original: nus-cs2103-AY1920S2/pe-interim#2599]}

[terencemah]

Team's Response

That is a valid point, but omitting the square brackets would not be wise either, because that would suggest the item is mandatory, when in fact for some parameters, it is forbidden. In this case, rather than adopting a new convention (other than square brackets) just for this specific section, we used square brackets to indicate that it may or may not be required/permitted (in a looser sense, optional). In any case, this is why we added the clarification right after, that "whether the index is required or possibly not allowed depends on the insight parameter", to minimise potential confusion. Additionally, to further minimise confusion, a comprehensive list of all possible command formats was given below, as shown in the attached screenshot. For anyone who reads the User Guide carefully, we believe how the command is to be used should be fairly clear, and their use of the product would not be affected; which is why we believe the severity of this issue is Low.

That said, it's a valid point that users who gloss through and only look at the format might possibly misunderstand. It might have been better had we also added in an asterisk after each square bracket, to denote that this is a special case, and direct users to read the clarification that follows.

Duplicate status (if any):

--