From f6f6b38c895d8998c63f6f5b4b7acb3b3c444de1 Mon Sep 17 00:00:00 2001 From: Harmon Date: Mon, 24 May 2021 16:52:16 -0500 Subject: [PATCH] Update and improve documentation for API.friends --- tweepy/api.py | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/tweepy/api.py b/tweepy/api.py index 1072c1b..aac1b74 100644 --- a/tweepy/api.py +++ b/tweepy/api.py @@ -2135,16 +2135,28 @@ class API: Returns a user's friends ordered in which they were added 100 at a time. If no user is specified it defaults to the authenticated user. - :param user_id: |user_id| - :param screen_name: |screen_name| - :param cursor: |cursor| - :param count: |count| - :param skip_status: |skip_status| - :param include_user_entities: |include_user_entities| + Parameters + ---------- + user_id + |user_id| + screen_name + |screen_name| + cursor + |cursor| + count + |count| + skip_status + |skip_status| + include_user_entities + |include_user_entities| - :rtype: list of :class:`User` objects + Returns + ------- + :py:class:`List`\ [:class:`~tweepy.models.User`] - :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friends-list + References + ---------- + https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friends-list """ return self.request( 'GET', 'friends/list', endpoint_parameters=( -- 2.25.1