linnn-7 / pe

0 stars 0 forks source link

Edit Feature Accepts Duplicate Index Should be Specified in User Guide #8

Open linnn-7 opened 5 months ago

linnn-7 commented 5 months ago

Problem: Edit command allows users to type commands like edit 1 1 d/PGPR that include duplicate indexes, and no warning is given. This is not specified in the user guide and the reader can be confused about the valid command format.

Screenshot:

Screenshot 2024-04-19 at 5.20.06 PM.png

No mentioning of duplicate indexes are allowed/disallowed.

nus-pe-script commented 5 months ago

Team's Response

Thanks for bringing this up! We agree with the statement "No mentioning of duplicate indexes are allowed/disallowed," but we disagree with the statement "the reader can be confused about the valid command format."

Regarding the given example of edit 1 1 d/PGPR, it is effectively the same as edit 1 d/PGPR. We believe that this outcome is expected and unambiguous, as we can hardly think of any other possible interpretation for a user command edit 1 1 d/PGPR. As such, we deem it unnecessary to have a warning or error message for that.

Hence, the statement "No mentioning of duplicate indexes are allowed/disallowed" itself does not necessarily indicate a flaw in the User Guide. A good User Guide should also be precise and concise to avoid redundant information, which can hinder the reader.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I appreciate your perspective. However, I disagree that clarifying whether duplicate indexes are allowed or disallowed would be redundant. Including such information serves to eliminate any ambiguity and ensures that command formats are crystal clear to users. Indeed, disallowing duplicate indexes is crucial, as commands like "edit 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 d/PGPR" could potentially introduce errors into the application. Prioritising clarity in the User Guide is essential, as it establishes a solid foundation of understanding for users before condensing information for brevity.