From: Harmon <Harmon758@gmail.com>
Date: Mon, 24 May 2021 22:11:18 +0000 (-0500)
Subject: Update and improve documentation for API.update_friendship
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=8dd544d173eb3175bf0e04acad04b1f500a94cf1;p=tweepy.git

Update and improve documentation for API.update_friendship
---

diff --git a/tweepy/api.py b/tweepy/api.py
index d819e56..5c516cf 100644
--- a/tweepy/api.py
+++ b/tweepy/api.py
@@ -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=(