search

Tempura-Person / pe

0 stars 0 forks source link

Add function documented incorrectly in User Guide's command summary #12

Open Tempura-Person opened 1 year ago

Tempura-Person commented 1 year ago

image.png

When explaining the command format earlier, it is stated that items in square brackets are optional. Conversely, items outside of square brackets are mandatory.

image.png

As such, it may not make sense to users that the parameters in the add command in the command summary have no brackets around any of them, and do not include all the parameters that could be added. (e.g. telegram handle)

If the app automatically assigns placeholders to parameters that are not provided, and it does not impede the usage of the app, then not all the parameters are mandatory and should be marked optional.

nus-pe-script commented 1 year ago

Your response not required for this bug as the team has accepted the bug as it is.