Update and improve documentation for API.statuses_lookup
authorHarmon <Harmon758@gmail.com>
Sat, 22 May 2021 12:57:23 +0000 (07:57 -0500)
committerHarmon <Harmon758@gmail.com>
Sat, 22 May 2021 12:57:23 +0000 (07:57 -0500)
tweepy/api.py

index f9720e1c5b7ebb20bb31f6372f587d07340d073c..72f554330a0086d8f14272e87751c495a2a4b9d2 100644 (file)
@@ -624,17 +624,29 @@ class API:
         Returns full Tweet objects for up to 100 Tweets per request, specified
         by the ``id`` parameter.
 
-        :param id: A list of Tweet IDs to lookup, up to 100
-        :param include_entities: |include_entities|
-        :param trim_user: |trim_user|
-        :param map: A boolean indicating whether or not to include Tweets
-                    that cannot be shown. Defaults to False.
-        :param include_ext_alt_text: |include_ext_alt_text|
-        :param include_card_uri: |include_card_uri|
+        Parameters
+        ----------
+        id
+            A list of Tweet IDs to lookup, up to 100
+        include_entities
+            |include_entities|
+        trim_user
+            |trim_user|
+        map
+            A boolean indicating whether or not to include Tweets that cannot
+            be shown. Defaults to False.
+        include_ext_alt_text
+            |include_ext_alt_text|
+        include_card_uri
+            |include_card_uri|
 
-        :rtype: list of :class:`Status` objects
+        Returns
+        -------
+        :py:class:`List`\ [:class:`~tweepy.models.Status`]
 
-        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-lookup
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-lookup
         """
         return self.request(
             'GET', 'statuses/lookup', endpoint_parameters=(