search

senwei01 / pe

0 stars 0 forks source link

Incorrect labelling for Filtering/Sorting commands in DG #14

Open senwei01 opened 2 years ago

senwei01 commented 2 years ago

image.png

I believe Filtering should be the same as the FIND command, which is already labelled further below in the user guide. This may be potentially confusing for readers.

nus-se-bot commented 2 years ago

Team's Response

Hi, our team believes that this is not an issue for the following reasons:

  1. It is technically true that find and findcom commands filter the list that the user sees. So the commands do filter the displayed list. You also agree that "Filtering" means the find command, which supports our point that these two words are quite equivalent.

  2. The target audience of the DG are developers. Many common languages all have some kind of filter command - Java has stream.fliter(), Python has filter, JavaScript has Array.filter()... So we believe that the word filter is quite commonly known by developers and this should not pose an issue.

    Items for the Tester to Verify

    :question: Issue response

Team chose [response.Rejected]

Reason for disagreement: While I agree that developers should know what filter is, I still find it erroneous to include it with the sort function, especially if you already have a find function below, it just feels redundant to put filtering together with the sort. As such, I still believe this is a documentation bug with a veryLow severity!