search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Explanations not provided for the examples in the "editing a patient" section #3247

Open nus-pe-bot opened 5 months ago

nus-pe-bot commented 5 months 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.

Expected

Explanations for the sample commands provided such that new users can intuitively grasp what the commands are doing.

For example: edit 1 p/Alex f/Fried rice Explanation: This command edits the 1st patient displayed on the contact list such that his/her preferred name is Alex and his/her food preference is Fried Rice.

Actual

Only the sample commands are provided without explanation. This may make it difficult for new users to understand what the sample commands are actually doing.

image.png

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

SherisseTJW commented 5 months ago

Team's Response

Hi, thanks for pointing this out.

However, we do provide explanations / further notes about the command format and the parameters we accept. The examples are there for the reader to see the full command, rather than just the command format.

As such, we do not think it is a valid issue as explanations are already provided regarding the command.

image.png

Duplicate status (if any):

--