search

wubojin / pe

0 stars 0 forks source link

Prefix glossary not comprehensive #4

Open wubojin opened 1 week ago

wubojin commented 1 week ago

The prefix glossary did not mention about sort/ which was mentioned in view_product.

This can cause confusion to readers as they would not be expecting a sort/ prefix but it suddenly appears in view_product.

image.png

image.png

soc-se-bot commented 4 days ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Lack of explanation for sort

It was mentioned that when viewing products, we can sort the products in increasing or decreasing order.

However in the format, it was simply just indicated as sort/i|sort/d.

This is quite unintuitive as I need to infer that i is for increasing and d is for decreasing.

It is also not clear that | means "or" and I have to infer that based on trial and error.

image.png

[original: nus-cs2103-AY2425S1/pe-interim#3674] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

No details provided by team.

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: Duplicate is invalid. This is inherently two different issues.

The 'Original' Bug is about how sort was badly explained in the user guide under the view_product feature. Badly explained in terms of how sort should be used.

The 'Duplicated' Bug is about how the prefix glossary does not contain sort/ prefix which affects overall readability. Although this may indirectly worsen the 'Original' Bug but resolving either one issue does not automatically resolve the other.

For example, by resolving the 'Duplicated' Bug, the prefix glossary now contain sort/ prefix and users would be expecting a sort later on in the UG. However, with the 'Original' Bug unresolved, the lack of proper explanation on the usage of sort can still cause difficulties for users in understanding the proper usage of sort in view_product.

Vice versa, by resolving the 'Original' Bug, the usage of sort is now properly explained clearly to users in view_product. However, with the 'Duplicated' Bug unresolved, the user might have some confusion reading view_product at the start as they were not made aware about sort/ prefix in the prefix glossary.