search

Alteqa / pe

0 stars 0 forks source link

It is specified in the command return line that names should be alphanumeric even though in the UG it is stated that it can only be alphabetical #5

Open Alteqa opened 2 months ago

Alteqa commented 2 months ago

In the app it returns saying that numerical values are allowed: image.png

In the UG:

image.png

soc-pe-bot commented 2 months ago

Team's Response

Thank you for raising this issue. We have noticed the discrepancy between the error command provided and the add command in the User Guide. We acknowledge this as a documentation oversight and recognize the need for improvement.

To address this, our User Guide should give a clearer warning: "The inclusion of alphanumeric characters is allowed. However, we recommend avoiding the creation of names consisting solely of numbers. This precaution ensures clarity, preventing situations where a command like delete 2 might be ambiguous, whether referring to deleting the entry at index 2 or the entry named 2. Furthermore, naming individuals with numbers is not practical in real-world scenarios, and could lead to confusion of who the person is, especially with a large number of contacts across multiple events."

Items for the Tester to Verify

:question: Issue type

Team chose [type.DocumentationBug] Originally [type.FunctionalityBug]

Reason for disagreement: It is mentioned that any numerical values is not permitted by the system in the guide, however, this ability to block numerical values were not implemented. Given that the ability to block numerical values is a functionality that was intended to be implemented as can be seen in the user guide, this is not a documentation error but rather a functionality bug.

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** This bug is flaw that causes inconvenience to all users utilising the guide, but they can continue to use the product, thus it is of medium severity.