breezetall / pe

0 stars 0 forks source link

Sort does not sort as intended #2

Open breezetall opened 5 months ago

breezetall commented 5 months ago

image.png

In the UG provided, the sort feature is stated to sort in ascending order (highest grades first) if ran without the "/r" prefix. However, sorting is in descending order in the jar.

image.png

nus-se-bot commented 5 months ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Conflicting Information in Sort UG

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.


Screenshot 2024-04-19 at 5.18.26 PM.png

ascending order appears twice in the description of the sort function. This is very problematic as it may confuse the reader, causing the reader to not know what to expect of the function.

**In addition, since there were bugs in the sort function where the list returned may be incorrect, this can lead to misinformation and even more confusion for the user.


[original: nus-cs2103-AY2324S2/pe-interim#2977] [original labels: severity.Medium 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: image.png

image.png

I agree that the information is conflicting in the UG and is confusing for the user. However, the DG and UG both states in their explanation that sort (without the /r) will display the highest grades first. But this is not the case in the actual application as seen below:

image.png

This is a separate issue from "ascending" appearing twice in the UG.


## :question: Issue type Team chose [`type.DocumentationBug`] Originally [`type.FunctionalityBug`] - [x] I disagree **Reason for disagreement:** DG: ![image.png](https://raw.githubusercontent.com/breezetall/pe/main/files/dc2e9bbf-4d61-4ec5-b310-2eee54f12aea.png) UG: ![image.png](https://raw.githubusercontent.com/breezetall/pe/main/files/3d54798d-5c20-4671-b0d9-4196022c3990.png) Both the UG and DG explains clearly that sort (without /r) will display the highest grades first. However, when using the sample addressbook.json, the sorting is done in the other order. Given that both the UG and DG goes into detail to explain the order of sort, it is more likely to be a functionality bug. steps to reproduce: 1) `sort ca1` ![image.png](https://raw.githubusercontent.com/breezetall/pe/main/files/5b43bbf1-3a97-4fae-a318-1357a0f30168.png)
## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]