nus-cs2113-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Search returns wrong result #633

Open nus-se-bot opened 2 years ago

nus-se-bot commented 2 years ago

Screenshot 2021-11-12 at 4.36.53 PM.png

The -f flag is used to specify a faculty. However, when I specify the faculty to be Soc, it returns me the modules from the History faculty instead.

When the input faculty is invalid, it is better to give no result than wrong results. (The UG did not specify if the search is fuzzy, hence accurate results are expected).

Screenshot 2021-11-12 at 4.42.04 PM.png Similarly, -d flag returns wrong result as well.


[original: nus-cs2113-AY2122S1/pe-interim#654] [original labels: type.FeatureFlaw severity.High]

ChewyChair commented 2 years ago

Team's Response

Downgrade in Severity See NotInScope

NotInScope

This is intentional, as stated in the UG:

image.png

This output is appearing since the faculty of the AH mods is Arts and Social Science, which contains soc. Similarly, the department of the DMA mods is Social Work, which contains soc.

This was implemented this way so that the user would be able to view computing mods by searching comp in either department or faculty without having to know the exact name of the faculty or department. We acknowledge that this might not be the best implementation, but it was a step up from our previous implementation where we needed an exact match.

This is not in scope since there are so many different faculties and departments on the NUSMods API, and they are not always very intuitive. For example, as seen before, the faculty of FASS mods is Arts and Social Science, rather than Faculty of Arts and Social Sciences (which is actually what they are referred to as on their official website) or FASS like one would think. For computing mods, the faculty is not soc or School of Computing as one would think, but instead is Computing. A perfect solution would require creating a list of terms (to include close matches and acronyms) for all of the faculties, and within them, all of their departments as well, which would require too much additional effort.

Duplicate status (if any):

--