search

octokit / octokit.js

The all-batteries-included GitHub SDK for Browsers, Node.js, and Deno.
MIT License
6.84k stars 1k forks source link

[DOCS(readme)]: Missing Required Parameter `issue_number` in `issues.createComment ` #2635

Closed junglesub closed 4 months ago

junglesub commented 4 months ago

Describe the need

Description:

While going through the README to familiarize myself with the octokit.js library, I encountered an issue regarding a missing required parameter, issue_number, in the example provided for the issues.createComment method in the webhooks section of the README.

Details:

The example provided for issues.createComment lacks the issue_number parameter, which is essential for the method to function correctly.

Suggested Improvement:

I suggest updating the example in the README to include the issue_number parameter, thereby preventing similar confusion for future users. This small adjustment would enhance the clarity and usability of the documentation.

Screenshot:

image

Referenced Documentation:

The documentation for the issues.createComment method can be found here.

SDK Version

No response

API Version

No response

Relevant log output

No response

Code of Conduct

github-actions[bot] commented 4 months ago

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

github-actions[bot] commented 3 months ago

:tada: This issue has been resolved in version 3.2.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: