search

nus-cs2103-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Inconsistent format for reminders on phone number format #3120

Open nus-pe-bot opened 3 years ago

nus-pe-bot commented 3 years 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.

The reminders of the format of STUDENT_PHONE_NUMBER and GUARDIAN_PHONE_NUMBER in editing a student and adding a student is different: one uses boxes with i icon and one uses bullet point

image.png

image.png

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

enhao25 commented 3 years ago

Team's Response

Thank you for your pointers. This, however, happens to be different with intention. Let me explain.

In adding a student, the STUDENT_PHONE_NUMBER and GUARDIAN_PHONE_NUMBER are critical (non-optional) parameters. Thus, we want to emphasize the pointers, putting them in the given format.

In editting a student, the parameters are only OPTIONAL. Hence, such a pointer will not apply to everyone using the edit feature. We decided that it should only be mentioned lightly, in a bullet point format.

If anything, it is a very low, cosmetic issue.

Duplicate status (if any):

--