nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Incorrect information in the fuzzy logic section #276

Open nus-se-script opened 4 months ago

nus-se-script commented 4 months ago

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

In this section, under the incorrect placements of whitespaces example, it shows that the fuzzy logic is able to handle the bouquet names as well. However, under the note section, it says that the fuzzy logic does not handle the bouquet names.


[original: nus-cs2113-AY2324S2/pe-interim#314] [original labels: severity.Low type.DocumentationBug]

IanFH commented 4 months ago

Team's Response

Under the incorrect placements of whitespaces, fuzzy logic is not able to handle bouquet names.

For c o m p are R ose /v s/ L i ly, there is not bouquet name in this. There is only compare which is a command and rose as well as Lily which are both flower names.

For m y b ouq ue ts, there is no bouquet name in this. m y b ouq ue ts will be corrected to mybouquets which is a command, not a bouquet name.

image.png

The above screenshot demonstrates that m y b ouq ue ts will be corrected to mybouquets and users can see that mybouquets is under the list of commands, which users can see if users input help.

On the other hand, you are right that under the note section, fuzzy logic does not handle the bouquet names. This is the intended effect as we would like to ensure that bouquet names are unique and are exactly as what the users input.

image.png

This screenshot demonstrates that a b c is different from bouquet name of abc.

Duplicate status (if any):

--