search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Misleading add recipe command under Recipe Management mode UG #2538

Open nus-se-script opened 1 month ago

nus-se-script commented 1 month ago

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.

image.png

From this image, if I input the following:

image.png

It still prompts me to input the recipe title again, making the UG unreliable because the command format is redundant.

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

64-1 commented 4 weeks ago

Team's Response

image.png

Single Command: image.png

Separate Command: image.png

It is stated in the UG for recipe management mode that even though the command word is "add", "add something" will still be accepted for the convenience of the user.

In the UG, for singular commands, are written in one whole code while for the mentioned commands it is separate code. Basically “command something” means you have to type together. “Command” “something” means you have to type the command first then it will prompt u to type the next part. It was done intentionally as in recipe mode, the user just need to type "add" and will be prompted for the "keyword".

Duplicate status (if any):

--