Skip to content

Commit

Permalink
docs: updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Dorukyum authored Jan 6, 2024
1 parent 532071d commit 1b57349
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions discord/rate_limiting.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
"""

Expand Down Expand Up @@ -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.
"""

Expand Down

0 comments on commit 1b57349

Please sign in to comment.