search

rahuljai-05 / pe

0 stars 0 forks source link

Uncertainty regarding order of items displayed upon list command #6

Open rahuljai-05 opened 1 week ago

rahuljai-05 commented 1 week ago

image.png image.png

Clearly, the order of the students displayed when the list command entered seems to be in the order of their insertion into the list at first. However, after running the allocate command, for some reason, the students seem to be displayed in increasing order of their ID's. This change in the order of the list due to a seemingly unrelated allocate command could cause confusion to the user, especially in case of large datasets/lists, making them think that they have changed something in the list unknowingly

nus-pe-script commented 3 days ago

Team's Response

Thank you for raising this issue. The "replacement" behaviour on the list in StudentList is mentioned in the developer guide.

Explanation:
image.png

Sequence Diagram:
Screenshot 2024-11-18 145031.png

As this behaviour is expected and works according to what we have defined, we will be rejecting this issue.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Screenshot 2024-11-21 183929.png

It's quite clear from the screenshot of the DG pasted above and the highlighted part in yellow/red that the expected behaviour is actually that the original student list does not change. This is what stands out to the eye and is expected to be the ideal behaviour. Not what has been encapsulated in the sequence diagram. If the intended ideal behaviour was that the studentList should change after the allocator command, then the highlighted portion of the screenshot should have been removed from the DG as it is misleading

image.png

I found a similar comment in the codebase as well indicating that the expected behaviour is that the original student list actually shouldn't change because of the allocate command. Thus I believe that the team should have fixed the functionality of the allocator command such that it does not affect the original student list or they should have removed all these conflicting comments, especially the one in the DG and provided more information under the list command itself, about how the order changes after calling the allocator command

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** Seems to be quite a serious issue especially because there have been conflicting statements made in the DG causing much confusion about the expected behaviour of the command