Unclear feature notes in the developer guide

[hweinian]

Description

It is quite ambiguous on what does mean? Does it mean to include spacing? Does it mean that it should be blank? But it says zero times as well. As a user, I am confuse on the purpose of it being in the note page.

Unsure if this is a typo or intended feature.

Ahh, after rereading it a couple of times, i realised that you are trying to show an example that you can include 0. I think this confuses the user more than it does helping them. Thus, i dont think this is a typo but rather, an intended example.

Screenshots

[nus-pe-bot]

Team's Response

Hi

We believe that the info "(i.e. 0 times)" already informs the user of the behavior. Furthermore, there is no difference in behavior if you type with a space or without a space as well.

That being said, this could indeed be a possible enhancement in the future, where we rephrase it something like below:

Items with ... after them can be used zero or more times
e.g. [t/TAG]... can be used as t/friends, or t/family t/friend, or omitted from the command entirely

Items for the Tester to Verify

❓ Issue response

Team chose [response.NotInScope]

• I disagree

Reason for disagreement:

Thank you for the response. Then, if there is no difference in behaviour, removing the spacing would indeed make it clearer and more concise to understand what your example is talking about. After all, technical documents exist to help others, which should be comprehensible.

Thus, this does not fall in line with response.NotInScope as the use of led to the ambiguity of the consideration on whether should I include a space, but if so, it should be done 0 times. Even if this was a typo, it does not fall qualify for response.NotInScope as stated in the Guidelines for bug triaging under documentation bugs. If it is not a typo, as mentioned above, removing it provides more clarity since its redundant which would not cause misunderstanding in the documentation.

Hence, this typo affects the understanding of the reader which falls more closely in line with the severity.low where it caused a minor inconvenience to the reader in which they question the purpose of the empty whitespace. The use of backticks indicate an emphasis on the whitespace which confuses the reader on why an emphasis is there. Hence, it would not be closer to severity.veryLow as it would be more than just a cosmetic issue.

---