nus-cs2103-AY2122S2 / pe-dev-response

0 stars 0 forks source link

Authors did not mention the format and constraints for the fields #3557

Open nus-pe-bot opened 2 years ago

nus-pe-bot commented 2 years ago

Screenshot 2022-04-16 at 2.58.43 PM.png

For example, the reader is not informed that phone numbers must be at least 3 digits long and emails must have a name and a domain. The examples, though helpful for regular operations, does not illustrate all these constraints fully


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

seanlaiys commented 2 years ago

Team's Response

We appreciate your valid concern about the constraints. The preventive measures in disallowing users of our application to add a person with a 1-2 digit phone number or an email without domain are primarily meant to act as a safety net for typographical errors. We believe that it is a rare case that a user actually intends to input a phone number with 1-2 digit(s) or input an email without domains, as it is extremely rare to have such phone number or email.

Moreover, we did not impose any further constraints on what a phone number or email could be such that additional clarifications are needed. Such constraints could often include restrictions to email domains or restrictions to the number of digits in a phone number specific to any country. While specifically stating the constraints does no harm, our team took the approach to concisely and sufficiently guide readers with the use of concrete examples to improve their understanding of what a phone number and email constitute.

These restrictions are also spelled out very clearly in error messages. Screenshot 2022-04-18 at 4.09.41 PM.png Screenshot 2022-04-18 at 4.11.37 PM.png

Duplicate status (if any):

--