search

yorklim / pe

0 stars 0 forks source link

add_student: Not stated in UG that email field and ID field has to be unique #7

Open yorklim opened 2 months ago

yorklim commented 2 months ago

When using the application, if a student has the same Student ID or email as another student, the user will be given an error that does not explain the issue, this condition is also not stated within the UG and thus the user may not know what is wrong with their usage.

image.png

soc-se-bot commented 2 months ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Error message of add_student is not specific enough

It seems like two students cannot have the same email and student ID, so when adding a student with the same email or student ID and error is given. However, error message given is not specific and is the same for both scenarios, whether the error is in the student ID or email.

This will result in the user not being able to figure out what is wrong with the command they entered as they will not know what to fix.

image.png

image.png

Steps to reproduce:

  1. Enter "/add_student name/Zack2 id/A4234567Z email/zack@example.com tag/Student "
  2. Error "already exists in the address book!" is given
  3. Enter "/add_student name/Zack2 id/A4234567Z email/zack@example.com tag/Student "
  4. Same error is given

[original: nus-cs2103-AY2324S2/pe-interim#4749] [original labels: severity.Low type.FeatureFlaw]

Their Response to the 'Original' Bug

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

Detailed in planned enhancement.

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: The 'Original' Bug is a problem with the error message within the application, whereas this report is regarding the lack of documentation of such behavior within the application

## :question: Issue response Team chose [`response.NotInScope`] - [x] I disagree **Reason for disagreement:** As compared to the 'Original' bug stated, this issue is related to the UG can could be fixed during 1.4. Furthermore, this affects the user for using the application normally due to the lack of documentation of such behavior.
## :question: Issue type Team chose [`type.FeatureFlaw`] Originally [`type.DocumentationBug`] - [x] I disagree **Reason for disagreement:** This relates to a behavior that is not stated anywhere within the application and thus the user will not know that the email and id has to be unique. Although this was mentioned in the implementation in the DG, users are unlikely to read the DG.