Misleading description in user guide

[1001mei]

Bug

• The use of word substring may lead user to think that list dul is equivalent to list module. Instead of substring, prefix would be more appropriate.

[nus-pe-script]

Team's Response

Using the word prefix may confuse the user as we use the term prefix to indicate the arguments the user provides for a specific command. Also, the team feels that it is unrealistic for people to type dul instead of mod. Lastly, we believe that our example provided will point the general users to use the first few characters as substring instead of taking a substring from the middle of the word.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

• [x] I disagree

Reason for disagreement: I understand that using the word prefix may confuse the user, but I am not convinced that this justifies the use of word substring. When the user guide specifies substring, the user is led to believe that using dul is indeed equivalent to using mod, despite the fact that it is not. Also, even though the provided examples do hint the user to use the first few characters as substring, this does not stop the user from thinking that taking any substring from any part of the word is okay.

This is not a mere problem of appropriateness of word choice, but a problem of misinformation. Thus, I disagree with the team's response of rejecting this bug.

---

:question: Issue severity

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

• [x] I disagree

Reason for disagreement: As this is not a pure cosmetic problem and in some cases can cause minor inconvenience to the user, I think the severity should be low instead of veryLow.

---