nus-se-script
commented
1 year ago Team's Response
The implementation of TreeSet is lower level. Furthermore, we are not the one implementing it and we are only using it since it does the sorting for us.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: I disagree. The problem is, from your description of sort in the DG, it is first of all unclear what the purpose of the sort feature is. Is it to sort in a particular order? Or to simply filter ? (if the order is arbitrary) If it is to filter, then perhaps explain its crucial differences in find, so that developers will know what the purpose of the feature is. If it is to sort, then what is the ordering? This is crucial because for example if someone implements the sorting to take into account the grade, it would not make sense if there is not ordering (i.e a module with B is displayed before A then suddenly B- appears etc..) Now we have established that the ordering is crucial, and you happen to state that you use treemap (which users a comparator to order elements) it is confusing to developers if it is not stated what order is desired. Either that or perhaps remove the implementation detail of treemap, and at a high level describe what the order the user is supposed to see (alphabetical, desceding ..) Since this will not cause terrible issues, I have already marked it veryLow, which I hope you will acknowledge that it means that this could be improved as it is not very clear.
In the developer guide, it is reasonable to assume that a developer would want to know further details about the sort feature, for example, a developer would want to know what order the modules are sorted in, is it specified, are there product design considerations of why the order should be in the particular way etc... however, it is just stated here that it is sorted by treeset, which although useful in describing the java implementation, does not really tell the developers any further details about how the sorting is done, and if there is any rationale of why it is done this way.