nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Many instances where parameter constraints are not mentioned in the UG. #285

Open nus-se-script opened 1 week ago

nus-se-script commented 1 week ago

Missing constraint for duplicate contact handling: Screenshot 2024-11-15 at 5.32.14 PM.png

Missing constraint for names (for example, name can only be alphanumeric): Screenshot 2024-11-15 at 5.33.29 PM.png

And many more in the UG such as phone number constraint, email address constraint.

Justification: UG is not intuitive, does not guide users in entering the correct command.


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

wassilililily commented 1 week ago

Team's Response

This is a good observation however, we feel that the current error messages do an appropriate job of guiding the user towards the correct format. We did not want to overcomplicate or flood the UG with too much details in this implementation. For the more unconventional formats (such as the billing date), we have included the appropriate parameter constraints in the UG. Hence, as per the description in the course website, we would move this suggestion to NotInScope as this is something that is not a high priority in this implementation and the current app informs users of the constraints of the parameter when the specific parameter constraints are breached.

Screenshot 2024-11-18 at 17.00.10.png

Duplicate status (if any):

--