Open MaYuehan opened 3 months ago
Most email addresses follow a common format, and that format is acceptable within the bounds of our input validation (and also stated in our error messages).
Hence, we did not see a need to explicitly mention this constraint as it would already fit what most end users expect.
However, for the sake of consistency, we accept this as a very low severity, minor documentation bug.
Team chose [severity.VeryLow
]
Originally [severity.Low
]
Reason for disagreement: No constrains stated in the UG might not affected normal operations of produce but it can cause inconvience in rare situations such as the users is not familiar with email address and forget the format of email. This fits the description of severity.low
As shown in the exception messages of add command, every fields have they own constrains, however, in the new user tutorial or the feature section, the constrains of some field are not stated. For exampple, the email field in add command: the exception message:![Screenshot 2024-04-19 at 4.37.57 PM.png](https://raw.githubusercontent.com/MaYuehan/pe/main/files/345cee1e-e281-4f63-86cb-e5a4ce216fb7.png)
the new user tutorial:![Screenshot 2024-04-19 at 4.25.13 PM.png](https://raw.githubusercontent.com/MaYuehan/pe/main/files/5cb0055b-d855-46b8-99c3-ff4f3f35d01e.png)
the feature sections:
the constrains of email field is also not included in the edit command.