nickeltea / pe

0 stars 0 forks source link

Inaccurate message #6

Open nickeltea opened 1 year ago

nickeltea commented 1 year ago

image.png

image.png

Given the member list shown in the first screenshot, executing either command: "find member -n " "find member -n"

Returns the message seen in the second screenshot.

This is misleading and instead a warning might want to be provided to tell users that no keyword to search for was provided. Due to the spacing shown in the message, it may be read as no members of the team have the spacing in their name, which is also untrue.

This is a functionality bug as the feature does not work as expected.

The severity is low as this does not affect normal operations and is rarely encountered.

nus-pe-bot commented 1 year ago

Team's Response

Hi, thank you for the bug report!

With regards to the example commands you have given, we feel that the application is giving the correct response and finding names with empty spaces is not in scope.

Firstly, the names are not meant to take in empty spaces. By searching the parameter name, the user can look for it's constraints, which are shown below.

image.png

image.png

Additionally, the response message directly informs the user that he has not entered any keywords, which makes sense as the empty space should not be entered in the first place. Another indicator would be the empty member section.

We also feel that this issue is out of scope as detecting when an empty space is being entered (and hence an invalid command) requires extra parsing logic that would not be allowed in v1.4.

On the other hand, we do agree that there could be more prominent indications to inform the user that empty spaces are not allowed to be entered / will not be recognised by the application, which can be done in the form of an alert / hyperlink to our parameter constraint section.

As such, we are categorising this as a documentation bug and hope you understand our rationale.

Hope you have a good reading week ahead! :)

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: Hi!

While your reasoning makes sense, it remains true that an empty space or no character at all is able to be entered, as seen in the example commands I provided: "find member -n ", "find member -n".

As you have explained, this is not meant to happen and thus there is a lack of proper handling for potentially invalid inputs as described in the screenshot below, taken from the module website.

image.png

Lastly, as can be seen in the screenshot at the bottom, "not in scope" can be proven if:

  1. The UG specifies it as not supported or coming in a future version.
  2. The user cannot attempt to use the missing feature or when the user does so, the software fails gracefully, possibly with a suitable error message i.e., the software should not crash.

Since the UG does not specify this behaviour, the command can be executed and no error message is given, neither of these points are fulfilled.

image.png


:question: Issue type

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

Reason for disagreement: Hi!

While your reasoning makes sense, it remains true that an empty space or no character at all is able to be entered, as seen in the example commands I provided: "find member -n ", "find member -n".

As you have explained, this is not meant to happen and thus there is a lack of proper handling for potentially invalid inputs as described in the screenshot below, taken from the module website.

image.png