nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Find command does not work with given example in user guide #3185

Open nus-se-script opened 3 days ago

nus-se-script commented 3 days ago
  1. Run add n/John Appleseed r/student p/98765400 e/johnd@example.com a/John street, block 123, #01-01
  2. Run find n/jo ap Screenshot 2024-11-15 at 4.40.49 PM.png
  3. Notice that John Appleseed isn't found.

Screenshot 2024-11-15 at 4.41.01 PM.png

Screenshot 2024-11-15 at 4.41.36 PM.png However according to the user guide, this should be a valid command, and John Appleseed should be displayed.


[original: nus-cs2103-AY2425S1/pe-interim#1922] [original labels: severity.High type.FunctionalityBug]

haleemairfan commented 2 days ago

Team's Response

I propose that this bug be classified as a documentation bug rather than a functionality bug, and its severity level reduced from High to Low. While the example provided in the user guide does not work as described, the user guide itself clearly outlines the constraints of the partial search feature—that it only matches parts of a name starting with the given keyword. As such, the product is functioning correctly according to these constraints, and the issue lies with the example being incorrect, not the functionality of the feature. Furthermore, this bug does not render the product unusable; it only causes a minor inconvenience for users if they rely on the faulty example. Once users refer to the user guide and follow its constraints, they can continue using the product smoothly. Given the minimal impact of this issue on the product's usability, it is more appropriately classified as Low Severity and a documentation bug.

Screenshot 2024-11-17 at 20.26.36.png

Duplicate status (if any):

--