Add documentation for Poll

diff --git a/docs/v2_models.rst b/docs/v2_models.rst
index f8e1b9c0b212edee7098253fb1a5d3ff8366264c..8d824ec4a5197a09679e4e1b856016d7ead8ad76 100644 (file)
--- a/docs/v2_models.rst
+++ b/docs/v2_models.rst
@@ -23,9 +23,10 @@ Models
 
 .. autoclass:: Place()
 
-.. class:: tweepy.Poll
+:class:`Poll`
+=============
 
-   :reference: https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/poll
+.. autoclass:: Poll()
 
 .. class:: tweepy.ReferencedTweet
 

diff --git a/tweepy/poll.py b/tweepy/poll.py
index 659a3e34601abcc4d8c6731eee81cb8531012816..45f27491dbd98421298e80b029c366ed7d230f63 100644 (file)
--- a/tweepy/poll.py
+++ b/tweepy/poll.py
@@ -7,6 +7,36 @@ from tweepy.utils import parse_datetime
 
 
 class Poll(HashableID, DataMapping):
+    """A poll included in a Tweet is not a primary object on any endpoint, but
+    can be found and expanded in the Tweet object. 
+
+    The object is available for expansion with
+    ``?expansions=attachments.poll_ids`` to get the condensed object with only
+    default fields. Use the expansion with the field parameter: ``poll.fields``
+    when requesting additional fields to complete the object.
+
+    .. versionadded:: 4.0
+
+    Attributes
+    ----------
+    data : dict
+        The JSON data representing the poll.
+    id : str
+        Unique identifier of the expanded poll.
+    options : list
+        Contains objects describing each choice in the referenced poll.
+    duration_minutes : int | None
+        Specifies the total duration of this poll.
+    end_datetime : datetime.datetime | None
+        Specifies the end date and time for this poll.
+    voting_status : str | None
+        Indicates if this poll is still active and can receive votes, or if the
+        voting is now closed.
+
+    References
+    ----------
+    https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/poll
+    """
 
     __slots__ = (
         "data", "id", "options", "duration_minutes", "end_datetime",