From fa2db0466320388c4c6053f7c30b344e01a2d914 Mon Sep 17 00:00:00 2001 From: Harmon Date: Mon, 24 May 2021 17:01:12 -0500 Subject: [PATCH] Update and improve documentation for API.show_friendship --- tweepy/api.py | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/tweepy/api.py b/tweepy/api.py index 77802ee..c8cdfec 100644 --- a/tweepy/api.py +++ b/tweepy/api.py @@ -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=( -- 2.25.1