From 205ddaff66b94f7da8affa9c9e6a3ec3a5537332 Mon Sep 17 00:00:00 2001
From: DA344 <108473820+DA-344@users.noreply.github.com>
Date: Thu, 30 May 2024 05:27:26 +0200
Subject: [PATCH] Update Polls event docs
---
discord/poll.py | 7 ++++++-
docs/api.rst | 9 +++++++--
2 files changed, 13 insertions(+), 3 deletions(-)
diff --git a/discord/poll.py b/discord/poll.py
index b8f036aec..c523f1609 100644
--- a/discord/poll.py
+++ b/discord/poll.py
@@ -446,7 +446,12 @@ class Poll:
@property
def created_at(self) -> Optional[datetime.datetime]:
- """:class:`datetime.datetime`: Returns the poll's creation time, or ``None`` if user-created."""
+ """Optional[:class:`datetime.datetime`]: Returns the poll's creation time.
+
+ .. note::
+
+ This will **always** be ``None`` for stateless polls.
+ """
if not self._message:
return
diff --git a/docs/api.rst b/docs/api.rst
index 44173d831..41cf6549d 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -1053,8 +1053,8 @@ Polls
.. function:: on_poll_vote_add(user, answer)
on_poll_vote_remove(user, answer)
- Called when a :class:`Poll` gains or loses a vote. If the ``user`` or ``message``
- are not cached then this event will not be called.
+ Called when a :class:`Poll` gains or loses a vote. If the ``user`` or ``answer``'s poll
+ parent message are not cached then this event will not be called.
This requires :attr:`Intents.message_content` and :attr:`Intents.polls` to be enabled.
@@ -1078,6 +1078,11 @@ Polls
This requires :attr:`Intents.message_content` and :attr:`Intents.polls` to be enabled.
+ .. note::
+
+ If the poll allows multiple answers and the user removes or adds multiple votes, this
+ event will be called as many times as votes that are added or removed.
+
.. versionadded:: 2.4
:param payload: The raw event payload data.