4ndrelim / pe

0 stars 0 forks source link

Description does not allow hyphens or dashes #2

Open 4ndrelim opened 1 year ago

4ndrelim commented 1 year ago

There are valid words/sentences that contain hypens or dashes and should be supported when adding a recipe into CookHub. Such words are also not uncommon in titles/description/steps of cookbooks. (title field also face the same issue)

It is also not explicitly stated in the UG that words with hyphens are not allowed / how they should be handled. Error message fails to capture this issue as well.

Screenshot 2023-04-14 at 2.27.29 PM.png

nus-se-bot commented 1 year ago

Team's Response

It is a feature flaw as we do not cater to hyphens when parsing user inputs for descriptions.

image.png

The 'Original' Bug

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

Add Command: Instruction does not allow for dashes

I believe that titles should be allowed to accept hyphen-dashes, espcially since there are words that exist in the dictionary that have dashes.

Not frequent to have such words but may still confuse the user especially since the error message claims that a word/sentence was not given for the title when orange-juice is considered a word

image.png


[original: nus-cs2103-AY2223S2/pe-interim#2765] [original labels: severity.Low type.FeatureFlaw]

Their Response to the 'Original' Bug

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

It is a feature flaw as we only take in alphanumeric and space when parsing user inputs for descriptions/titles/etc.

image.png

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: I don't think it's a duplicate issue for the following reasons:

  1. My main concern is that hyphens and dashes should be supported in the parsing of titles, tags and steps / when adding recipe into CookHub. While i did mention error message, it is more of an 'add-on' reason to inform that the error message isn't helpful in explaining why my proposed input failed.

  2. i stand by my decision that it is ultimately a FunctionalityBug (explained below under dispute for 'Issue type') and is possibly a medium severity (explained below as well)


## :question: Issue type Team chose [`type.FeatureFlaw`] Originally [`type.FunctionalityBug`] - [x] I disagree **Reason for disagreement:** After some consideration, i still think this issue can qualify as a `FunctionalityBug`. I understand the argument that the issue is a `FeatureFlaw` is because the team had only intended for alphanumeric characters and spaces in the respective fields, but no where was this stated (pls correct me if i'm wrong) in the UG nor DG. I, as a user wouldn't have known that. It therefore seems natural (from reading the UG and common understanding) that valid English words, including those hyphenated (eg. compound words), would be accepted as well. Hence, when the app singles out and fails to add recipes with certain words, i interpreted it as a `FunctionalityBug` because it fails to do what it is expected to do.
## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** ![Screenshot 2023-04-18 at 7.54.09 PM.png](https://raw.githubusercontent.com/4ndrelim/pe/main/files/adf12bb2-1949-4cc4-9c84-9170289f0dfb.png) Indeed, users can continue using CookHub even with this issue, but this issue is not at all uncommon as explained in my original post. Further, part of the value proposition of CookHub is to offer a quick, easy look-up of recipes. It can be quite displeasing to users (and may even cause slight confusion if the compound word is not read as a whole but only partially) if the app does not support the basic use of hyphens and dashes. "heat over medium-high skillet for 10-15mins", "fry until golden-brown", "pour mixture into 3 5-inch mold" are certainly not uncommon phrases in recipes. Hence, i believe this issue has enough significance to be addressed or at least discussed in planned enhancements.