nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

add command parameter specifications unclear in the User Guide (student number) #1028

Open nus-se-script opened 11 months ago

nus-se-script commented 11 months ago

In the add command section of the User Guide, only restrictions on the name and phone number of the student are provided, as well as an incomplete restriction on the student number.

Based on testing, the true restriction on the student number is: Student numbers must be of the format A[nnn][c]

Where [nnn] is any numerical input of any length, and [c] is any alphabetical character.

It is likely that without this information, users will misinput information, at least for the first time, and have to use the displayed error message to rectify their inputs instead. This is inconvenient and is likely to happen often.


[original: nus-cs2103-AY2324S1/pe-interim#1579] [original labels: type.DocumentationBug severity.Medium]

Cikguseven commented 11 months ago

Team's Response

image.png

Student Number format has been clearly specified in the Features Section before the add command.

Duplicate status (if any):

--