tzhan98 / pe

0 stars 0 forks source link

User guide Example for addapplicant #13

Open tzhan98 opened 2 years ago

tzhan98 commented 2 years ago

More examples could be provided. Even though the documentation says Examples, only one was provided. Furthermore, there was no examples of adding with the field tag, although the field was optional, there should be an example of it as it is the only unique field (which is optional and can an applicant can have multiple tags)

image.png

soc-pe-bot commented 2 years ago

Team's Response

"More examples could be provided. Even though the documentation says Examples, only one was provided." This is a suggestion, not a bug. Our example is correct.

"Furthermore, there was no examples of adding with the field tag, although the field was optional, there should be an example of it as it is the only unique field" We cannot possibly put all possible combinations inside. We have provided the format and what each field represents. It is clear to the user what the command format should be like.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: While it is certainly impossible to include all possible combinations of /tag, there should be at least one example showing how to input multiple tags. Currently there is no example showing how to add multiple instances of /tag.

In the error example in the app, it shows (from what I assume) that multiple tags can be added with spaces? This is unclear if I can add multiple tags with spaces or t/.

image.png