Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorrect labelling for Filtering/Sorting commands in DG #5775

Open
nus-pe-bot opened this issue Nov 11, 2022 · 1 comment
Open

Incorrect labelling for Filtering/Sorting commands in DG #5775

nus-pe-bot opened this issue Nov 11, 2022 · 1 comment

Comments

@nus-pe-bot
Copy link

nus-pe-bot commented Nov 11, 2022

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.



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.


[original: nus-cs2103-AY2223S1/pe-interim#5764] [original labels: severity.VeryLow type.DocumentationBug]
@seelengxd
Copy link
Contributor

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.

Duplicate status (if any):

--

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants