leeyiheng12 / pe

0 stars 0 forks source link

Inconsistent documentation regarding case-sensitivity of optional tags #11

Open leeyiheng12 opened 2 years ago

leeyiheng12 commented 2 years ago

On page 5 of the UG, it is mentioned that optional tags are case-sensitive.

image.png

However, on page 9, it is mentioned that tags (which presumably included optional tags) are not case-sensitive.

image.png

This would affect the equality comparison of an tag, since it is unsure whether two tags with different cases are meant to be considered the same or not, and since it is mentioned that "Applications are considered duplicates if they have the same name, job title and optional tags.", this could lead to the equality comparison of an application being affected, which could lead to the app's behaviour being different from what the user intended.

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]

Repeated tags are allowed

To reproduce:

1) Type add n/TestCompany j/TestJob15 p/1234 e/testemail@test.sg a/TestAddress(123456) pt/HIGH ast/ACCEPTED t/tagtest t/TAGTEST

Expected behaviour:

Only one tag present

Actual behaviour:

Two tags present, even though tags are meant to be case insensitive.


[original: nus-cs2103-AY2122S2/pe-interim#915] [original labels: severity.Medium type.FeatureFlaw]

Their Response to the 'Original' Bug

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

Accept this Bug. The intended behaviour of the Tags is to be case-sensitive and Priority Tags and Application Status Tags are case-insensitive. Due to a documentation error, the information presented was mixed which resulted in this bug being reported, as it is only under the edit command that we made the error of stating it is case insensitive, but under notes, it is stated that optional tags are case sensitive. But we will consider this a VeryLow Severity DocumentationBug.

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: [replace this with your explanation]


:question: Issue severity

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

Reason for disagreement: image.png

According to the website, bugs of severity "very low" are flaws that are purely cosmetic, do not affect usage (e.g. typos, color, font issues), and only cosmetic problems should have this label.

Differing instructions on how to use the tag would confuse the user. Furthermore, the unclear equality comparison of tags would cause a user to (e.g. when trying tags such as "abc" vs "ABC") experience behaviour different from what was expected.

If tags are indeed case sensitive, then in page 9 of the UG, then the user may believe otherwise, and assume "abc" and "ABC" would be the same tag. And since applications use tags internally to compare equality, this may cause seemingly similar applications to be treated differently. Irregardless, this is definitely not just of very low severity.