search

nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Documentation: User guide does not indicate that index has to be less than or equal to the number of contacts #2257

Open nus-se-script opened 1 day ago

nus-se-script commented 1 day ago

image.png

image.png

Currently, from the descriptions that are provided in the user guide, there is no clear indication that the provided index has to be less than or equal to the number of contacts in a list. While this might seem like a given, as this application is all-purpose and intended for TA's across faculties, it is possible for such a user to be unfamiliar with indexing, particularly if they are not from a STEM faculty.

Perhaps you could add this clarification for clarity in the User Guide.

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

Oceankoh commented 9 hours ago

Team's Response

Hi,

Thanks for your report. However, we disagree with the statement that TAs "unfamiliar with indexing" to assume that an index can be greater than the number of available contacts. Since the user guide is targeted at teaching assisants (the intended user of TAHub) who are the cream of the crop , the assumed level of knowledge rather high. Additionally, the app does throw an appropriate error to inform that user that the index provided is not valid.

Duplicate status (if any):

--