maxxng / pe

0 stars 0 forks source link

Inconsistency of examples for command in UG #12

Open maxxng opened 3 years ago

maxxng commented 3 years ago

Under the Find room command feature:

Actual:

  1. ofind 10- returns 10-100 , 10-101 , and 10-102
  2. ofind 10- 15- returns 10-100 , 10-101 , 15-100 , and 15-101

Expected:

  1. ofind 10- returns 10-100 , 10-101 , and 10-102
  2. ofind 10- 15- returns 10-100 , 10-101 ,10-102, 15-100 , and 15-101

From the first 2 lines, it is rather confusing how the ofind command works since it is assumed that the list of room would remain constant.

Screenshot 2021-04-16 at 3.36.35 PM.png

nus-pe-bot commented 3 years ago

Team's Response

Reasons:

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: If ofind 10- returns 10-100 , 10-101 , and 10-102 then why does ofind 10- 15- not include 10-102 as part of the values being returned?

As the reader, this lead me to think that the ofind command will return at most 2 results for each keyword in the case for multiple keywords being inputted, since each keyword has exactly 2 search results.

Just because a section is clearly explained does not mean there is no need for the examples to be clear.


:question: Issue severity

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

Reason for disagreement: I have to agree that the severity is not supposed to be as high as I indicated. However, this will affect the reader's flow of reading the UG if they have to stop and think about the implications of the inconsistency in examples provided, this causes a minor inconvenience.