Update and improve documentation for API.show_friendship

Automatically use docstring for documentation
Improve method and documentation order

diff --git a/docs/api.rst b/docs/api.rst
index 4aefab5918718cc7767d6f7f9b5952d93cac77fe..9bee31364450b151e9d79b14ad7526b205e8b0ca 100644 (file)
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -127,6 +127,8 @@ Follow, search, and get users
 
 .. automethod:: API.friendships_outgoing
 
+.. automethod:: API.show_friendship
+
 
 User methods
 ------------
@@ -271,18 +273,6 @@ Friendship Methods
    :rtype: :class:`User` object
 
 
-.. method:: API.show_friendship(source_id/source_screen_name, \
-                                target_id/target_screen_name)
-
-   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.
-   :rtype: :class:`Friendship` object
-
-
 Account Methods
 ---------------
 

diff --git a/tweepy/api.py b/tweepy/api.py
index 0dec71af09c294be216e9c60cc1ce1a69dc6ab49..b596962b22087126ee284cf300218130e8b74144 100644 (file)
--- a/tweepy/api.py
+++ b/tweepy/api.py
@@ -1569,6 +1569,29 @@ class API:
             ), **kwargs
         )
 
+    @payload('friendship')
+    def show_friendship(self, **kwargs):
+        """show_friendship(*, source_id, source_screen_name, target_id, \
+                           target_screen_name)
+
+        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.
+
+        :rtype: :class:`Friendship` object
+
+        :reference: 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=(
+                'source_id', 'source_screen_name', 'target_id',
+                'target_screen_name'
+            ), **kwargs
+        )
+
     def media_upload(self, filename, *, file=None, chunked=False,
                      media_category=None, additional_owners=None, **kwargs):
         """ :reference: https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/overview
@@ -1854,17 +1877,6 @@ class API:
             ), **kwargs
         )
 
-    @payload('friendship')
-    def show_friendship(self, **kwargs):
-        """ :reference: 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=(
-                'source_id', 'source_screen_name', 'target_id',
-                'target_screen_name'
-            ), **kwargs
-        )
-
     @payload('json')
     def get_settings(self, **kwargs):
         """ :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-account-settings