Add documentation
ThermScissorpunch opened this issue · 4 comments
Is is possible to add documentation on how to simply use this plugin?
It would help a lot :-)
Woof, Woof!
Thank you @ThermScissorpunch for submitting the "Add documentation" issue
⚡ Tobias has found some errors ⚡
- A
descriptionsection is expected - Length of the issue body is less than 120 characters
- Either
bugorenhancementlabel must be set
Please do not forget to review our internal guidelines:
- Describe the problem in the best possible way
- Include at least the
Descriptionsection, but considered adding other sections - Avoid suggesting immediate solutions, think deeply about the problem
- Engage in the Triage process being as responsive as possible
- Understand and accept the possibly large amount of execution time
- Avoid immediate reallocation of the issue, let triage do their job
Engaging in the development process in the best possible way helps it being efficient and fast.
Your friend,
Tobias (Platforme's mascot)
I appreciate the time you took to raise awareness about the lack of example usage of this package.
Are you having trouble using this package in your javascript projects? If so, I can provide some help. But if you already know how to use it, I encourage you to open a pull request to improve the documentation.
Furthermore, are you having trouble instantiating the API client and calling a method? Or do you find the documentation regarding each method parameter to be lacking and therefore you do not know what properties to pass?
Let me know if this PR solves your issues.
@ThermScissorpunch pinging you on this matter, otherwise closing it in a few days.
Woof, Woof!
Oops! @joao-conde it looks like you've assigned the issue to multiple persons.
There can only be one person assigned - @ThermScissorpunch was removed from issues assignees list.
Your friend,
Tobias (Platforme's mascot)