4llysa / pe

0 stars 0 forks source link

ug: add does not specify conditions of name uniqueness #12

Open 4llysa opened 3 months ago

4llysa commented 3 months ago

in your app, add n/John Doe m/A1234567Z e/johnd@u.nus.edu tl/johndoe01 t/cs2109s t/G19Group1 and add n/John Doe m/A1234567Z e/johnd@u.nus.edu tl/johndoe01 t/cs2109s t/G19Group1

can both run successfully in succession. ( because of the additional spaces in name)

As a user, i would expect these names to be considered unique, but the UG does not tell me what is considered unique and what is not

nus-pe-bot commented 2 months ago

Team's Response

Planned enhancements state that UUID is to be changed to matric number instead of name. Hence duplicate detection for names will not be needed in the future.

In the future, in the event that there are duplicate names, if matric numbers provided are the same, an error will be thrown since duplicate detection will be handled by the matric number.

Furthermore, if duplicate names are provided with different matric numbers, they will be accepted as 2 separate individuals with the same name, since their (unique) matric numbers are different.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Having a planned enhancement to not use student names as unique identifiers is good. However, it does not address the issue that in this version, you should have properly documented what it means for names to be considered "unique".

"John Doe" and "John Doe" (two spaces between) are considered different names by your app even though they are "unique". The point is that "unique" is not properly defined.

This may be a minor detail, but it is not documented through in app errors or help page (with links back to the UG) and may lead to confusion.


## :question: Issue type Team chose [`type.FeatureFlaw`] Originally [`type.DocumentationBug`] - [x] I disagree **Reason for disagreement:** This issue was raised specifically about the UG and not the feature.