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

index 70e2a30007999a2e1268e7c9decc6470108cd870..11c7c367b2edca547c1077a9fcda5847fcb1a56e 100644 (file)
@@ -974,12 +974,20 @@ class API:
 
         Retweets a Tweet. Requires the ID of the Tweet you are retweeting.
 
-        :param id: |sid|
-        :param trim_user: |trim_user|
+        Parameters
+        ----------
+        id
+            |sid|
+        trim_user
+            |trim_user|
 
-        :rtype: :class:`Status` object
+        Returns
+        -------
+        :class:`~tweepy.models.Status`
 
-        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-retweet-id
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-retweet-id
         """
         return self.request(
             'POST', f'statuses/retweet/{id}', endpoint_parameters=(