ganhongyao / pe

0 stars 0 forks source link

Email constraint not specified in user guide #7

Open ganhongyao opened 2 years ago

ganhongyao commented 2 years ago

... but is an error in the application.

nus-pe-bot commented 2 years ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

User Guide does not mention email format

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.


As mentioned in the title. Would have been good to add this error format listed below in the UG to give users some instruction, before throwing an error.

image.png


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

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Any valid email that a user would want to enter would follow the relatively lax email format. The user should not need to have this information to use the command. A user entering an email with wrong format is very likely an actual mistake, rather than intentional.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]


:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Users may choose to specify a value like To be confirmed in the email field. This is an example of an intentional use case, and thus the UG should state this constraint clearly in the UG, just like all the other constraints such as name and tag.