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

fix doc for ratelimit data, fixes #3131 #3132

Merged
merged 3 commits into from Mar 7, 2019

Conversation

Projects
None yet
2 participants
@almostSouji
Copy link
Contributor

almostSouji commented Mar 7, 2019

Please describe the changes this PR makes and why it should be merged:

  1. Adapt the rateLimit event documentation to use the actual data property limit instead of the current requestLimit as actually emitted in:

    this.client.emit(RATE_LIMIT, {
    limit: this.requestLimit,
    timeDifference: this.timeDifference,
    path: item.request.path,
    method: item.request.method,
    });

  2. Change the order properties are documented in to reflect the emitted data

Status

  • Code changes have been tested against the Discord API, or there are no code changes
  • I know how to update typings and have done so, or typings don't need updating

Semantic versioning classification:

  • This PR changes the library's interface (methods or parameters added)
    • This PR includes breaking changes (methods removed or renamed, parameters moved or removed)
  • This PR only includes non-code changes, like changes to documentation, README, etc.

almostSouji added some commits Mar 7, 2019

@SpaceEEC SpaceEEC merged commit be2f788 into discordjs:11.4-dev Mar 7, 2019

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.