search

liuy1103 / pe

0 stars 0 forks source link

Slightly confusing structure of the UG #4

Open liuy1103 opened 2 months ago

liuy1103 commented 2 months ago

The delete function was introduced first before the list function, but under the delete function, there is a line that talked about "list (with no SORT_TYPE specified)", which affects readability of the UG to a certain extent as I was trying to test the delete function, but didn't know what the list with no SORT_TYPE represent and I had to read the list function before testing the delete function. Perhaps the sequence of introducing the commands can be made clearer/improved.

image.png

nus-se-bot commented 2 months ago

Team's Response

Sure, thanks for pointing that out. We have marked this as 'Very Low' since the description of list is directly below delete. We do see how this is confusing though, thank you!

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: [replace this with your explanation]