search

Hikoya / pe

0 stars 0 forks source link

Name of author cannot contain "/" #1

Open Hikoya opened 2 years ago

Hikoya commented 2 years ago

This can be quite troublesome for authors with names "Damith s/o Nathan" in Indian culture. or "Saree d/o Nathan"

Expected: Command should allow "/" Actual: Error thrown

image.png

nus-se-script commented 2 years ago

Team's Response

Linked to #4605. This issue has been acknowledged.

The 'Original' Bug

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

Unable to include special character in book author

Description: Some books may be written by people with academic/political/military titles that may include special characters. Hence, it should be allowed in author field of book.

Command used: add book t/E Book Title : Diving into Wonders of XYZ a/A/Prof Herman Melville

Expected output: able to add book with A/Prof Herman Melville as author

Actual output: "The name of Author should only contain alphanumeric characters and spaces, and it should not be blank."

Screenshot 2022-11-11 at 4.19.02 PM.png

Severity is given as low as users may remove the special characters when inputing the book author but it is not ideal especially if its used by an academic library which will have more of such book authors.

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

Their Response to the 'Original' Bug

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

We are categorising this issue as a Feature Flaw for overzealous input validation. All duplicate issues are classified together as they originate from a common parsing design choice (Eg. User names and Book Authors) in our product.

However, we are changing the severity from Medium to Low for mainly 3 reasons (under design considerations):

  1. We have specified in the Developer Guide that our target users are "librarians managing a small library". Therefore, we consider this issue to be quite rare since it will only affect an extremely small number of people with special characters in their names.
  2. The issue can be circumvented on the user side by replacing special characters with spaces (Eg. "s/o" to "s o"), which still retains readability to the user.
  3. Given the current implementation of our product, it will take a lot more effort to ensure such cases are handled correctly, which in turn risk our product to run into more bugs that are possibly more severe than the others. This is very true for real-case scenarios faced by certain companies as well.

    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.FeatureFlaw] Originally [type.FunctionalityBug]

Reason for disagreement: [replace this with your explanation]

:question: Issue severity

Team chose [severity.Low] Originally [severity.Medium]

Reason for disagreement: [replace this with your explanation]