search

gigituang / pe

0 stars 0 forks source link

Find command unable to filter our KEYWORDs properly #2

Open gigituang opened 2 years ago

gigituang commented 2 years ago

Screenshot 2022-04-16 at 2.39.17 PM.png

after typing 'find PE final' I tot i could find something with the word PE, but it only read the 'final' part and listed out final quiz. the meetings with the keyword PE is not. probably to make it easier, you can standard the find command by only allowing the input of one keyword, so as to simplify the search process:)

Screenshot 2022-04-16 at 2.42.00 PM.png

nus-se-bot commented 2 years ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Misleading find command format

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.

Screenshot 2022-04-16 at 3.26.04 PM.png

This 'more Keywords' can be pretty misleading as i inferred it as the find command can find a string of unlimited keywords. But when I tried, it couldnt

[original: nus-cs2103-AY2122S2/pe-interim#1063] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Thank you for raising this issue.

The find command does actually perform a search with all keywords included, but as mentioned the search is an AND search, i.e. all keywords must appear in the meeting for it to be a successful match. Additionally, the search will search through the meeting's name, module, and tags; it will also do a partial word match.

Following examples shown below:

  1. find weekly - the meeting names contains weekly

image.png

  1. find weekly check - the only meeting that contains weekly and check (in the name)

image.png

  1. archive, then find pe exam
    • meeting 1 contains pe in the tag openbook, and exam in the tag exams
    • meeting 2 also contains pe in the tag openbook, and exam in the tag exams
    • meeting 3 contains pe and exam in the name PE Exam

image.png

We would like to apologise for not making the examples in the find command clearer. Thank you once again for bringing up this issue.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: According to the DG stating that only meetings that match all keywords will be returned. In this case PE does not exist and is ignored and only Final Quiz was filtered out, which I believe is a feature flaw and a warning message should be raised. It would be good to warn the user that the one of the KEYWORDS does not exist.

:question: Issue type

Team chose [type.DocumentationBug] Originally [type.FeatureFlaw]

Reason for disagreement: I believe that this is a feature flaw as the find function ignored the non-existent keyword and removes filters the rest without informing the user.

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]