From 1de3e437ab0d0dbce83360afc253627a2120d1e7 Mon Sep 17 00:00:00 2001 From: Harmon Date: Mon, 24 May 2021 17:08:35 -0500 Subject: [PATCH] Update and improve documentation for API.create_friendship --- tweepy/api.py | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/tweepy/api.py b/tweepy/api.py index 27c5d3b..fe7aa43 100644 --- a/tweepy/api.py +++ b/tweepy/api.py @@ -2427,14 +2427,23 @@ class API: Create a new friendship with the specified user (aka follow). - :param screen_name: |screen_name| - :param user_id: |user_id| - :param follow: Enable notifications for the target user in addition to - becoming friends. + Parameters + ---------- + screen_name + |screen_name| + user_id + |user_id| + follow + Enable notifications for the target user in addition to becoming + friends. - :rtype: :class:`User` object + Returns + ------- + :class:`~tweepy.models.User` - :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/post-friendships-create + References + ---------- + https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/post-friendships-create """ return self.request( 'POST', 'friendships/create', endpoint_parameters=( -- 2.25.1