search

chiangqinkang / pe

0 stars 0 forks source link

Find error message inconsistent with user guide #4

Open chiangqinkang opened 1 week ago

chiangqinkang commented 1 week ago
  1. Run find p/2
  2. Notice error message Phone numbers should only contain numbers, and it should be at least 3 digits long
  3. Run find p/2334 4.Notice the same error message remains

Screenshot 2024-11-15 at 4.26.46 PM.png

soc-se-bot commented 1 week ago

Team's Response

Thank you for the feedback. We acknowledge this bug, however we believe that it should be of severity low as we simply did not edit the usage message to reflect that the phone numbers should contain 8 digits. Since the app is meant for users in Singapore (as evidenced by localized app name and addressed in a different response), the expected inputs are 8-digit phone numbers, which our app correctly checks for. The erroneous usage message may cause confusion, but does not affect the functionality of our app. Furthermore, our user guide states the correct phone number constraints. Hence, this is a minor concern and not a critical bug that disrupts any functionalities and it should be a documentation bug.

The 'Original' Bug

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

Incorrect Add person error message for phone number more than 8 digits long

When trying to add a person with phone number of more than 8 digits, i got the message that it should be at least 3 digits long.

Steps: Add command from example but add an extra digit to make it more than 8 digits long.

Expected: Phone numbers can contain only numbers and should be exactly 8 digits long

Actual: Phone numbers should only contain numbers, and it should be at least 3 digits long

image.png

[original: nus-cs2103-AY2425S1/pe-interim#3965] [original labels: severity.Medium type.FeatureFlaw]

Their Response to the 'Original' Bug

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

Thank you for the feedback. We acknowledge this bug, however we believe that it should be a documentation bug of severity low. The usage message is not updated and does not reflect that phone numbers should contain 8 digits. However, since the app is meant for users in Singapore (as evidenced by localized app name and addressed in a different response), the expected inputs are 8-digit phone numbers, which our app correctly checks for. The erroneous usage message may cause confusion, but does not affect the functionality of our app. It is also not a feature flaw since, given our app's target users and context, it makes sense for phone numbers to be only 8 digits long. It is a documentation issue, since error messages communicate instructions to users. Furthermore, our user guide states the correct phone number constraints. Hence, this is a minor concern and not a critical bug that disrupts any functionalities and it should be a low severity documentation bug.

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]

## :question: Issue type Team chose [`type.DocumentationBug`] Originally [`type.FunctionalityBug`] - [x] I disagree **Reason for disagreement:** This is not a documentation bug, which is classified as "A flaw in the documentation e.g., a missing step, a wrong instruction, typos". A documentation bug would imply that the UG should state that the "3 digits long" should be stated in the UG. However, documentation bugs do not occur in real-time application behavior, and the issue is with the application's behavior, not the documentation.