wapisai / pe

0 stars 0 forks source link

confusing format parameters for link #33

Open wapisai opened 6 months ago

wapisai commented 6 months ago

Screenshot 2024-04-19 at 5.31.50 PM.png

link ID [MORE_ID] is confusing as users may think that ID and MORE_ID refers to different kinds of parameters

the explanation here is unclear, hard to understand

soc-pe-bot commented 6 months ago

Team's Response

Thank you for your feedback. ID and MORE_ID are precisely explained in the below parameters section of our UG(as shown in your screenshot). It indicates index of the selected contacts. Because it is located right below the format section, it is very unlikely that user think ID and MOREID refers to different kinds of parameters. Also, the underbar() helps separation of ID from the MORE word, they are able to understand it clearly. There are also examples for the link command to help understanding right below it.

image.png

Also this is common usage of MORE in AB3 UG for your reference: image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: ID and [MORE_ID] sounds like different parameters you could have simply said "link ID ..." and explained (perhaps in command format section) that the ... means that unrestricted number of the parameters can be provided

doing this can also resolve the problem in bug report #35 "too many unecessary exmaples" as this will solve your need to tell users that an unrestricted number of parameters can be provided, without providing unnecessary examples that are not helpful

even if AB3 has it, it is still a bug from AB3 that should have been addressed