search

nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

UG did not specify the commands works on original list or filtered list #2783

Open nus-pe-bot opened 2 weeks ago

nus-pe-bot commented 2 weeks ago

Problem: It is unclear whether the second command should work on the filtered list based on the first command or the original list, as UG did not specify this, hence unsure users may input multiple commands in the hope that all of them work on original list, only to discover that they do not.

image.png

Suggestion: Specify the commands works on original list or filtered list in UG so that users know what to expect.

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

mattisongjj commented 2 weeks ago

Team's Response

The User Guide already specifies that commands requiring an index (e.g., edit, bookmark, remark, etc.) operate on "the index number shown in the displayed company list," which clearly refers to the filtered list and not the original list​

Screenshot 2024-11-18 at 3.35.42 PM.png

The screenshot in the bug report confirms the bug reporter was using the edit command, and the behavior of this command aligns with what is documented in the UG.

Furthermore, users cannot reasonably expect commands that operate on indexed entries to work on an invisible list not shown on screen (i.e., the original list if a filtered list is displayed).

This is not a valid documentation bug and is hence rejected because the documentation already clarifies the behavior. The user's confusion appears to stem from a misunderstanding or oversight, not from a flaw in the UG.

Duplicate status (if any):

--