nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Insufficient documentation on the find command (i.e. field that the command searches for) #2605

Open nus-pe-bot opened 2 weeks ago

nus-pe-bot commented 2 weeks ago

The UG documentation of the find command does not specify that the app searches for contacts based on the name field. But when I tried to search for a contact with the email address better@gmail.com with the command find better, no results show up. Screenshot 2024-11-15 at 5.13.14 PM.png

Screenshot 2024-11-15 at 5.14.39 PM.png

Screenshot 2024-11-15 at 5.15.12 PM.png


[original: nus-cs2103-AY2425S1/pe-interim#3549] [original labels: severity.Low type.DocumentationBug]

seandias commented 2 weeks ago

Team's Response

We acknowledge that there’s always room for improvement, and we’ll certainly make it clearer in future iterations. That said, we did take steps to ensure clarity in this version. For instance, we explicitly mentioned names in the special comments section and consistently demonstrated this using names in all our examples. By doing so, we aimed to make it evident that the feature was referring to names. While we understand that there’s a chance for misinterpretation, we believe the documentation provides sufficient context to convey the intended meaning effectively. Screenshot 2024-11-18 at 11.13.28 AM.png

Duplicate status (if any):

--