UG () used are confusing

[nus-pe-bot]

It states that brackets are used when one of the items inside is compulsory.

However, in the command summary, it only shows the find and sort command using () to encompass PARAMETER such as e/ph/all Other commands such as List and Delete separate e, ph and all into separate commands which is a bit confusing at first as I had thought the separated commands meant that the commands had something else changed other than the PARAMETER.

delete e INDEX delete ph INDEX

had a difference other than using the e or ph.

Maybe could standardise using () or just listing e, ph or all as separate commands so that there is no confusion.

---

_{[original: nus-cs2103-AY2425S1/pe-interim#741] [original labels: severity.Low type.DocumentationBug]}

[thortol]

Team's Response

Reason for dropping to severity very low

The reason its very low is because its a standardization issue. The users can still follow what is written in the command summary and get the right output. No minor inconvenience is caused.

Reason for not in scope

The team intentionally chose this design as all commands that do not wrap to the next line we decided to list into separate commands to make it easier for the users to understand. For the long commands, we decided not to list into separate commands as it will become messy quickly.

Duplicate status (if any):

--