From e5e63ac1af3f3438b92b46d4436357b59169f256 Mon Sep 17 00:00:00 2001 From: Harmon Date: Wed, 7 Apr 2021 13:21:23 -0500 Subject: [PATCH] Update and improve documentation for API.show_friendship Automatically use docstring for documentation Improve method and documentation order --- docs/api.rst | 14 ++------------ tweepy/api.py | 34 +++++++++++++++++++++++----------- 2 files changed, 25 insertions(+), 23 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 4aefab5..9bee313 100644 --- 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 0dec71a..b596962 100644 --- 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 -- 2.25.1