mirror of
https://github.com/Rapptz/discord.py.git
synced 2025-06-07 12:18:59 +00:00
Some docs fixes for polls
This commit is contained in:
parent
2f479b2ac6
commit
9d979d3df1
@ -807,6 +807,10 @@ class InteractionResponse(Generic[ClientT]):
|
||||
then it is silently ignored.
|
||||
|
||||
.. versionadded:: 2.1
|
||||
poll: :class:`~discord.Poll`
|
||||
The poll to send with this message.
|
||||
|
||||
.. versionadded:: 2.4
|
||||
|
||||
Raises
|
||||
-------
|
||||
|
@ -202,7 +202,7 @@ class PollAnswer:
|
||||
|
||||
@property
|
||||
def poll(self) -> Poll:
|
||||
""":class:`Poll`: Returns the parent poll of this answer"""
|
||||
""":class:`Poll`: Returns the parent poll of this answer."""
|
||||
return self._poll
|
||||
|
||||
def _to_dict(self) -> PollAnswerPayload:
|
||||
@ -310,7 +310,7 @@ class Poll:
|
||||
The duration of the poll. Duration must be in hours.
|
||||
multiple: :class:`bool`
|
||||
Whether users are allowed to select more than one answer.
|
||||
Defaultsto ``False``.
|
||||
Defaults to ``False``.
|
||||
layout_type: :class:`PollLayoutType`
|
||||
The layout type of the poll. Defaults to :attr:`PollLayoutType.default`.
|
||||
"""
|
||||
@ -431,7 +431,7 @@ class Poll:
|
||||
|
||||
@property
|
||||
def answers(self) -> List[PollAnswer]:
|
||||
"""List[:class:`PollAnswer`]: Returns a read-only copy of the answers"""
|
||||
"""List[:class:`PollAnswer`]: Returns a read-only copy of the answers."""
|
||||
return list(self._answers.values())
|
||||
|
||||
@property
|
||||
|
21
docs/api.rst
21
docs/api.rst
@ -3615,7 +3615,7 @@ of :class:`enum.Enum`.
|
||||
|
||||
.. class:: PollLayoutType
|
||||
|
||||
Represents how a poll answers are shown
|
||||
Represents how a poll answers are shown.
|
||||
|
||||
.. versionadded:: 2.4
|
||||
|
||||
@ -5077,6 +5077,14 @@ PartialWebhookChannel
|
||||
.. autoclass:: PartialWebhookChannel()
|
||||
:members:
|
||||
|
||||
PollAnswer
|
||||
~~~~~~~~~~
|
||||
|
||||
.. attributetable:: PollAnswer
|
||||
|
||||
.. autoclass:: PollAnswer()
|
||||
:members:
|
||||
|
||||
.. _discord_api_data:
|
||||
|
||||
Data Classes
|
||||
@ -5347,18 +5355,15 @@ Poll
|
||||
|
||||
.. attributetable:: Poll
|
||||
|
||||
.. autoclass:: Poll()
|
||||
.. autoclass:: Poll
|
||||
:members:
|
||||
|
||||
.. attributetable:: PollAnswer
|
||||
|
||||
.. autoclass:: PollAnswer()
|
||||
:members:
|
||||
:inherited-members:
|
||||
PollMedia
|
||||
~~~~~~~~~
|
||||
|
||||
.. attributetable:: PollMedia
|
||||
|
||||
.. autoclass:: PollMedia()
|
||||
.. autoclass:: PollMedia
|
||||
:members:
|
||||
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user