search

alex-setyawan / pe

0 stars 0 forks source link

More clarification should be made for different usages of square brackets #11

Open alex-setyawan opened 2 months ago

alex-setyawan commented 2 months ago

In command examples, square brackets indicate optional fields. But in specifying NRIC numbers, square brackets indicate 1 character, as shown below.

image.png

It would be good to put some clarification just below the NRIC regular expression string on what it means for seamless usage.

soc-se-bot commented 2 months ago

Team's Response

Since this is related to NRIC format, we would mark this as duplicate of #4482.

The 'Original' Bug

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

UG constraint on NRIC format is not clear

image.png It is never specified that X should only be numbers. As a foreigner, I do not really know what the Singapore's NRIC format is just based on the UG.

image.png add ic/SA974944F n/John Doe p/91234567 e/johndoe@email.com g/M b/19-04-1000 d/Paracetamol | Penicillin i/Infectious Diseases

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

Their Response to the 'Original' Bug

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

Regarding UG, this issue is valid due to the fact that some user might not be familiar with the Singapore NRIC format and the UG does not specify what X must be. However, the actual usage of the application is mainly copying the actual NRIC of a person into the system which is through their NRIC card or official documents that already by itself contains the valid NRIC value. Hence this can be seen a rare inconvenience and thus Low severity and is Accepted.

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]