ids or index

[wapisai]

the way ids are referred to is not standardised

users may be confused

eg in paramters its referred to as indexes in notes is referred to as ids

[nus-pe-script]

Team's Response

Thank you for your feedback. It was clearly identified in the userguide that id indicates index. The use of id and index does not seem to cause any confusion. The note was discussing about parameters, so our parameter name ID is more appropriate to use. On the other hand, the example uses index because it is meant to explain the actual indexes of person exported, when the command receive ID as a parameter. For this reason, the word index is more self-explanatory. As their usages were appropriate, this not a documentation bug.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

• [x] I disagree

Reason for disagreement: im talking about the standardization of id some parts use "ids" some parts use "ID" some parts use "indexes"

i understand that index is IDs

but the way they are use is not standardized like in the callout u use "ids" instead of "IDs" and additionally, the "ids" are not in code blocks which is not standardized with the above when "ID" is in code blocks

this is a very easy fix and says a lot about the quality of the work

Also you say that " id indicates index" so since they are interchangeable why is there a need to use them for different situations as u said below?

"The note was discussing about parameters, so our parameter name ID is more appropriate to use. On the other hand, the example uses index because it is meant to explain the actual indexes of person exported, when the command receive ID as a parameter. For this reason, the word index is more self-explanatory."

---