search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Further elaboration for the `edit` command #3055

Open nus-se-script opened 7 months ago

nus-se-script commented 7 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.

image.png

It should be elaborated within this point what exactly the "EMPLOYEE_ID" is. While it is stated in the introduction, it might not be clear for a user who clicks the hyperlink straight to this command.

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

BryanL2303 commented 7 months ago

Team's Response

This is a claim that is not just exclusive for EMPLOYEE_ID. This has already been addressed at the top of the features section on command formats.

If the user clicks straight to the edit function, the user would also not understand that the [] is meant to indicate optional parameters or the NAME is meant to indicate that the user should type a name as an input. As such we would expect that the reader would eventually go up and read that section even if they first skipped it. It would be very unnecessary for us to copy the entire command format section and paste it under every single command.

Duplicate status (if any):

--