Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document new .onAny() / .onError() methods #345

Closed
gr2m opened this issue Oct 30, 2020 · 1 comment · Fixed by #400
Closed

Document new .onAny() / .onError() methods #345

gr2m opened this issue Oct 30, 2020 · 1 comment · Fixed by #400
Labels
Type: Bug Something isn't working as documented, or is being fixed

Comments

@gr2m
Copy link
Contributor

gr2m commented Oct 30, 2020

follow up to #324

We deprecated .on("*", handler) and .on("error", handler) in favor of new .onAny/.onError methods, but forgot to document the new methods in the README

I really want to build a CI integration that checks if documentation was updated when we apply a feature label

@gr2m gr2m added Type: Bug Something isn't working as documented, or is being fixed documentation labels Oct 30, 2020
@gr2m
Copy link
Contributor Author

gr2m commented Oct 30, 2020

As part of that, let's remove documentation for special events: https://github.com/octokit/webhooks.js/#special-events, and update the usage example at https://github.com/octokit/webhooks.js/#usage

@wolfy1339 wolfy1339 linked a pull request Dec 30, 2020 that will close this issue
@gr2m gr2m closed this as completed in #400 Dec 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Bug Something isn't working as documented, or is being fixed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant