search

kokerinks / pe

0 stars 0 forks source link

UG: error under `Parameter Constraints` #4

Open kokerinks opened 4 months ago

kokerinks commented 4 months ago

In Parameter Constraints, this is stated under the email parameter:

image.png

however, the application does not accept just any values for email. For example:

image.png

This may be confusing for the user. The UG should be updated to reflect the validations for emails.

Edit: I found the additional clause for email later in the user guide.

image.png

However, it is likely to be missed by the user as there is no linking from the email parameter explanation and the Warning message. A hyperlink or footnote should be included to avoid this.

nus-se-bot commented 4 months ago

Team's Response

When the user has inputted just edit 1 e/email, there is a clear error message displayed in the response panel. The user can then follow those instructions to make the necessary amendments without having to scroll too much into the User Guide.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The issue is not whether the error message is informative or not, the issue is that it is very misleading to state that the email can contain any values (without any footnote or asterisks) when it actually does not.

While the email address field accepts any values, it is important to adhere to the following: The local-part before the '@' symbol can only contain alphanumeric characters and the special characters "+_.-". The local-part cannot start or end with any special characters. After the '@' symbol, there should be a domain name composed of domain labels separated by periods. The domain name must end with a label containing at least 2 characters. Each domain label should start and end with alphanumeric characters, and consist only of alphanumeric characters >with hyphens allowed as separators, if necessary.

In fact, it is contradictory to state that the email can accept any value, then proceed to state multiple restrictions for the field. The email in fact does not accept some values.

The two sections of the UG screenshotted (under Parameter Constraints and Warning message) should be fixed to avoid confusion for readers.