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

index 2b0a029f83bb06c4391c2f8d800ca4711958d52a..77618bac1566169fc52e450cda645f506204d174 100644 (file)
@@ -891,12 +891,20 @@ class API:
         Favorites the status specified in the ``id`` parameter as the
         authenticating user.
 
-        :param id: |sid|
-        :param include_entities: |include_entities|
+        Parameters
+        ----------
+        id
+            |sid|
+        include_entities
+            |include_entities|
 
-        :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-favorites-create
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-favorites-create
         """
         return self.request(
             'POST', 'favorites/create', endpoint_parameters=(