Skip to content

Commit

Permalink
docs: clarify Member.current_timeout expiry (#1063)
Browse files Browse the repository at this point in the history
Tiny documentation change to clarify that `Member.current_timeout` also
returns `None` when the current timeout value is in the past, allowing
users to safely rely on this behavior.
  • Loading branch information
shiftinv committed Oct 30, 2023
1 parent ead81a4 commit a67c634
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion disnake/member.py
Original file line number Diff line number Diff line change
Expand Up @@ -695,7 +695,9 @@ def voice(self) -> Optional[VoiceState]:

@property
def current_timeout(self) -> Optional[datetime.datetime]:
"""Optional[:class:`datetime.datetime`]: Returns the datetime when the timeout expires, if any.
"""Optional[:class:`datetime.datetime`]: Returns the datetime when the timeout expires.
If the member is not timed out or the timeout has already expired, returns ``None``.
.. versionadded:: 2.3
"""
Expand Down

0 comments on commit a67c634

Please sign in to comment.