search

nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

The need for the FIELD command is not specified well #6031

Open nus-se-script opened 1 year ago

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

Screenshot 2023-11-17 at 5.35.34 PM.png

The UG mentions that "We understand the edit command can be a little tedious to use if you only want to edit a single field of a client profile." However, making use of the edit command to alter a single field uses as much code as a FIELD command for the same field, barring the 'edit' keyword. Hence, the need or the value of the FIELD command has not been specified well.

[original: nus-cs2103-AY2324S1/pe-interim#6033] [original labels: type.DocumentationBug severity.Medium]

KamiliArsyad commented 1 year ago

Team's Response

This is not a documentation bug and more of a feature recommendation. The edit command is less intuitive and we provide this command as a shortcut for it.

Duplicate status (if any):

--