Update and improve documentation for API.retweets
authorHarmon <Harmon758@gmail.com>
Sat, 22 May 2021 13:17:02 +0000 (08:17 -0500)
committerHarmon <Harmon758@gmail.com>
Sat, 22 May 2021 13:17:02 +0000 (08:17 -0500)
tweepy/api.py

index f5b4dfbbc8f775154ce607687f3c1c5c9d5f1944..633c52aa251cff3ccd97f99c650b45a2b26f3836 100644 (file)
@@ -782,13 +782,22 @@ class API:
 
         Returns up to 100 of the first Retweets of the given Tweet.
 
-        :param id: |sid|
-        :param count: |count|
-        :param trim_user: |trim_user|
+        Parameters
+        ----------
+        id
+            |sid|
+        count
+            |count|
+        trim_user
+            |trim_user|
 
-        :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-retweets-id
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-retweets-id
         """
         return self.request(
             'GET', f'statuses/retweets/{id}', endpoint_parameters=(