nus-cs2113-AY2122S2 / pe-dev-response

0 stars 0 forks source link

Improper UG description of optional fields #1204

Open nus-pe-bot opened 2 years ago

nus-pe-bot commented 2 years ago

The UG states that square brackets are optional fields above, however, in the case of the search command, only one field is needed and will be used.

This means that the square brackets here are not optional, but should be omitted instead.

image.png

image.png


[original: nus-cs2113-AY2122S2/pe-interim#1161] [original labels: type.DocumentationBug severity.VeryLow]

thernturnaround commented 2 years ago

Team's Response

The user can use both name and description together to narrow the search. Search will do a match on name AND description, if the user uses both.

Moreover, the use of "at least one" implies that a user can use both.

image.png

Duplicate status (if any):

--