nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

Behaviour of Filter not Specified Completely #4313

Open nus-se-script opened 9 months ago

nus-se-script commented 9 months ago

For the filter command feature, the user guide actually states that "All tags containing the words or part-thereof will be matched (e.g. Ba will return Badminton or Basketball or Football or Backgammon )" but does not state that other fields such as name, phone also follow this behaviour.

For example, "filter n/A" will filter all the person whose name contain A(or a). But this behaviour is not stated in UG. (The UG does state this behaviour for tag, but not other field).


[original: nus-cs2103-AY2324S1/pe-interim#3301] [original labels: type.DocumentationBug severity.VeryLow]

Fallman2 commented 9 months ago

Team's Response

The implementation is specified in the initial explanation of the function as shown here.

image.png

Furthermore, in the examples, there are examples illustrating clearly how the function works for other parameters (reference the 2nd example).

Screenshot 2023-11-20 at 8.11.50 PM.png

The explanation for tags is expanded upon in the following points as it is possible to have more than one tag (and so possible to have more than one tag match the same parameter) whereas it is not possible to have more than one of the other fields. However, this is a possible improvement to improve the clarity of the UG and so has been marked "Not in scope".

Duplicate status (if any):

--