search

nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Inconsistency with optional fields in edit_event in UG #1251

Open nus-pe-bot opened 2 weeks ago

nus-pe-bot commented 2 weeks ago

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

image.png

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

image.png

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

image.png

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

[original: nus-cs2103-AY2425S1/pe-interim#529] [original labels: severity.Low type.DocumentationBug]

G-Y-Chan commented 2 weeks ago

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.

Duplicate status (if any):

--