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

index 77802ee2db2a4bfaf193d8f1e23dffb111506062..c8cdfec550a9d932bdcee27d5b437ea42a29afd2 100644 (file)
@@ -2285,14 +2285,24 @@ class API:
 
         Returns detailed information about the relationship between two users.
 
-        :param source_id: The user_id of the subject user.
-        :param source_screen_name: The screen_name of the subject user.
-        :param target_id: The user_id of the target user.
-        :param target_screen_name: The screen_name of the target user.
+        Parameters
+        ----------
+        source_id
+            The user_id of the subject user.
+        source_screen_name
+            The screen_name of the subject user.
+        target_id
+            The user_id of the target user.
+        target_screen_name
+            The screen_name of 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/get-friendships-show
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-show
         """
         return self.request(
             'GET', 'friendships/show', endpoint_parameters=(