From: Harmon <Harmon758@gmail.com>
Date: Tue, 6 Apr 2021 23:29:44 +0000 (-0500)
Subject: Update and improve documentation for API.retweets_of_me
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=76725baf0b567ec70e79ea7fceb60c9ef9ffa971;p=tweepy.git

Update and improve documentation for API.retweets_of_me

Automatically use docstring for documentation
Add trim_user, include_entities, and include_user_entities parameters to documentation
Remove page parameter from documentation
Improve parameter order in documentation
Improve capitalization
---

diff --git a/docs/api.rst b/docs/api.rst
index 45d19bd..216d93b 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -41,16 +41,7 @@ Post, retrieve, and engage with Tweets
 
 .. automethod:: API.retweets
 
-.. method:: API.retweets_of_me([since_id], [max_id], [count], [page])
-
-   Returns the 20 most recent tweets of the authenticated user that have been
-   retweeted by others.
-
-   :param since_id: |since_id|
-   :param max_id: |max_id|
-   :param count: |count|
-   :param page: |page|
-   :rtype: list of :class:`Status` objects
+.. automethod:: API.retweets_of_me
 
 
 Status methods
diff --git a/tweepy/api.py b/tweepy/api.py
index 9e2af5a..2a25475 100644
--- a/tweepy/api.py
+++ b/tweepy/api.py
@@ -514,7 +514,22 @@ class API:
     @pagination(mode='id')
     @payload('status', list=True)
     def retweets_of_me(self, **kwargs):
-        """ :reference: https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-retweets_of_me
+        """retweets_of_me(*, count, since_id, max_id, trim_user, \
+                          include_entities, include_user_entities)
+
+        Returns the 20 most recent Tweets of the authenticated user that have been
+        retweeted by others.
+
+        :param count: |count|
+        :param since_id: |since_id|
+        :param max_id: |max_id|
+        :param trim_user: |trim_user|
+        :param include_entities: |include_entities|
+        :param include_user_entities: |include_user_entities|
+
+        :rtype: list of :class:`Status` objects
+
+        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-retweets_of_me
         """
         return self.request(
             'GET', 'statuses/retweets_of_me', endpoint_parameters=(