leongdl135 / pe

0 stars 0 forks source link

UG: Unclear documentation on Email #9

Open leongdl135 opened 1 year ago

leongdl135 commented 1 year ago

As a user, I am uncertain what does local-part and domain mean.

image.png

nus-se-script commented 1 year ago

Team's Response

An email address, such as john.smith@example.com, is made up from a local-part, the symbol @, and a domain, which may be a domain name or an IP address enclosed in brackets.

This statement is taken from Wikipedia on email addresses. The terms local-part and domain are explained on the site. These terms are internationally known to be what makes up an email address. Moreover, since our target audience is computer science students, they should know what these terms mean. This also does not provide any misunderstanding since majority of people know what constitutes an email address and any valid email address they enter would be accepted.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I disagree since the definition of local-part that you have provided does not reflect the behavior in the application. According to the Wikipedia site, local-part is as shown.

image.png

However, when trying to enter the email david!@gmail.com, this error message appears.

image.png

It is stated clearly over here that the local-part can only accept 4 special characters as opposed to what was stated in Wikipedia. Since your application's email input validation is different from the "internationally known" definition on Wikipedia, shouldn't your group have stated more clearly as to what local-part means? I believe that stating local-part should contain only alphanumeric characters and 4 special characters would suffice. Instead, your group has chose to throw in new terms that are not reflective of the actual behavior of your application.

The same argument can be made for domain where your application provides a slightly different form of validation as compared to the one in Wikipedia but I shall refrain from bringing in more examples.

Furthermore, while you argued that this application is targeted towards computer science students and they should know what these terms mean, I personally did not know what exactly these terms mean before googling them. After googling them, the definition is also different from the one your application does. As such, I believe that explanations of the terms local-part and domain should be included since your application provides a slightly different form of input validation and will thus reduce user misunderstanding.