mitchwadair / tesjs

Streamline your Twitch EventSub JavaScript integration with TESjs
https://www.tesjs.net/
MIT License
29 stars 6 forks source link

docs: Fix code snippet for getSubscriptionsByStatus #86

Closed LinneB closed 10 months ago

LinneB commented 10 months ago

Description

This pull request fixes the code snippet for getSubscriptionsByStatus, as it used to be the same as getSubscriptionsByType.

Additions

Changes

Testing

I didn't find any documentation tests, but it looks correct to me.

mitchwadair commented 10 months ago

Hi! Good catch, thanks for the PR. The docs are generated from the JSDoc in the code, so you'll want to update it there and generate the doc instead to get it properly updated. https://github.com/mitchwadair/tesjs/blob/a1c8f46965f4615cc2ddf1539169dcb3e550b4b4/lib/tes.js#L236

Once you make the change there, you can run npm run build to generate the updated doc

LinneB commented 10 months ago

I see. I updated the code snippet in lib/tes.js so it matches the new snippet.

mitchwadair commented 10 months ago

LGTM, thanks again for the PR!