diff --git a/CHANGELOG.md b/CHANGELOG.md index 099de0d4ed..99de6b4c2a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -82,7 +82,7 @@ These changes are available on the `master` branch, but have not yet been releas - Added `default_reaction_emoji` parameter to `Guild.create_forum_channel()` and `ForumChannel.edit()` methods. ([#2178](https://github.com/Pycord-Development/pycord/pull/2178)) -- Added `.rate_limiting` module to support rate limit prediction. +- Added `rate_limiting` module to support rate limit prediction. ([#2188](https://github.com/Pycord-Development/pycord/pull/2188)) ### Changed @@ -115,7 +115,7 @@ These changes are available on the `master` branch, but have not yet been releas ([#2099](https://github.com/Pycord-Development/pycord/pull/2099)) - Changed the support from `orjson` to `msgspec` in the codebase. ([#2170](https://github.com/Pycord-Development/pycord/pull/2170)) -- Replaces former rate limit system with a rate limit prediction and easing system. +- Replaced former rate limit system with a rate limit prediction and easing system. ([#2188](https://github.com/Pycord-Development/pycord/pull/2188)) ### Removed diff --git a/discord/rate_limiting.py b/discord/rate_limiting.py index 897ff274dc..d1fe0368f6 100644 --- a/discord/rate_limiting.py +++ b/discord/rate_limiting.py @@ -47,7 +47,7 @@ class GlobalRateLimit: The concurrency to reset every `per` seconds. per: :class:`int` | :class:`float` Number of seconds to wait until resetting `concurrency`. - remaining: :class:`int` | MISSING + remaining: :class:`int` Number of available requests remaining. If the value of remaining is larger than concurrency a `ValueError` will be raised. @@ -133,9 +133,9 @@ class Bucket: ---------- metadata_unknown: :class:`bool` Whether the bucket's metadata is known. - remaining: Union[:class:`int`, None] + remaining: Optional[:class:`int`] The remaining number of requests available on this bucket. - limit: Union[:class:`int`, None] + limit: Optional[:class:`int`] The maximum limit of requests per reset. """ @@ -276,10 +276,10 @@ def set_metadata( Parameters ---------- - remaining: :class:`int` | `None` + remaining: Optional[:class:`int`] The remaining number of requests which can be made to this bucket. - reset_after: :class:`int` | `None` + reset_after: Optional[:class:`int`] The number of seconds until this bucket will next reset. """