Browse Source

Update Polls event docs

pull/10109/head
DA344 1 year ago
committed by dolfies
parent
commit
f3d0c0e2f8
  1. 7
      discord/poll.py
  2. 9
      docs/api.rst

7
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

9
docs/api.rst

@ -1269,8 +1269,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.
.. note::
@ -1290,6 +1290,11 @@ Polls
Called when a :class:`Poll` gains or loses a vote. Unlike :func:`on_poll_vote_add` and :func:`on_poll_vote_remove`
this is called regardless of the state of the internal user and message cache.
.. 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.1
:param payload: The raw event payload data.

Loading…
Cancel
Save