Update and improve documentation for API.update_friendship
authorHarmon <Harmon758@gmail.com>
Mon, 24 May 2021 22:11:18 +0000 (17:11 -0500)
committerHarmon <Harmon758@gmail.com>
Mon, 24 May 2021 22:11:18 +0000 (17:11 -0500)
tweepy/api.py

index d819e561d2983327b77b2196c7636b3d6ec68cd1..5c516cf343947a792b8776609381a0bda7c2f662 100644 (file)
@@ -2484,14 +2484,24 @@ class API:
 
         Turn on/off Retweets and device notifications from the specified user.
 
-        :param screen_name: |screen_name|
-        :param user_id: |user_id|
-        :param device: Turn on/off device notifications from the target user.
-        :param retweets: Turn on/off Retweets from the target user.
+        Parameters
+        ----------
+        screen_name
+            |screen_name|
+        user_id
+            |user_id|
+        device
+            Turn on/off device notifications from the target user.
+        retweets
+            Turn on/off Retweets from the target user.
 
-        :rtype: :class:`Friendship` object
+        Returns
+        -------
+        :class:`~tweepy.models.Friendship`
 
-        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update
         """
         return self.request(
             'POST', 'friendships/update', endpoint_parameters=(