Howlong11 / pe

0 stars 0 forks source link

Lack of example on valid email inputs on UG #13

Open Howlong11 opened 2 months ago

Howlong11 commented 2 months ago

image.png

The user guide does not give examples on what each:

means. this makes users hard to understand whether the input is valid or not.

nus-se-script commented 2 months ago

Team's Response

In the screenshot above, two examples of valid emails are already provided. Each of these examples already fulfill all the criteria of a valid email, making it clear to users what valid inputs look like.

Including an example for each of the constraints is unnecessarily repetitive and will bloat the UG.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: None of the examples in the user guide as the screenshot given includes the cases which are numerical or includes hyphen. It may confuse the user of where in the email they are able to include numerical inputs or hyphens.


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]