heeeyi / pe

0 stars 0 forks source link

Does not specify that "sort" after "only" command will only sort the filtered items #14

Open heeeyi opened 1 year ago

heeeyi commented 1 year ago

image.png

Previously, I did an "only" command to filter the items. Later, I want to sort the entire recipe book by price.

image.png

However, I found that what is sorted is NOT the original list, but the filtered list. The documentation should at least make clear about this, that sort inside only is different from sort alone.

nus-se-script commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

User Guide does not specify correct behaviour for Sort feature

Section Affected

User Guide - Sort recipe by cost

Description

As a user reading the user guide, after finding certain recipes and deleting them based on their index number, I wanted to view the remaining recipes that I have in my recipe book, sorted by price. I followed the instructions and descriptions given in the User Guide, however, I end up with no recipes in my list. The user guide did not make it clear to me that the sorting would be done on the items in the list that I am currently viewing, but instead mentioned that the sorting is done on the "recipes in your recipe book" which suggests that the sorting should be done on the remaining recipes in my recipe book and not the recipe list that I am currently viewing.

image.png


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

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

No details provided by team.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** I feel this is not Low. This is because using filter-based functions like "only" followed by "sort" is not very rare operations. Sometimes user may want to sort the records they have just filtered, or the user may have done a filter, and want to do another sort on all records. Under either situations, users may have different expectations, and could be quite surprised if the software does not behave as expected. Hence, it is crucial for documentation to make clear of this.