From e39953cfb571ee480457d4761a8dfde8bef30f6a Mon Sep 17 00:00:00 2001 From: Harmon Date: Sat, 22 May 2021 07:53:15 -0500 Subject: [PATCH] Update and improve documentation for API.favorites --- tweepy/api.py | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/tweepy/api.py b/tweepy/api.py index 6a07be3..0713537 100644 --- a/tweepy/api.py +++ b/tweepy/api.py @@ -586,16 +586,27 @@ class API: Returns the favorite statuses for the authenticating user or user specified by the ID parameter. - :param user_id: |user_id| - :param screen_name: |screen_name| - :param count: |count| - :param since_id: |since_id| - :param max_id: |max_id| - :param include_entities: |include_entities| + Parameters + ---------- + user_id + |user_id| + screen_name + |screen_name| + count + |count| + since_id + |since_id| + max_id + |max_id| + include_entities + |include_entities| - :rtype: list of :class:`Status` objects + Returns + ------- + :py:class:`List`\ [:class:`~tweepy.models.Status`] - :reference: https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-favorites-list + References + https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-favorites-list """ return self.request( 'GET', 'favorites/list', endpoint_parameters=( -- 2.25.1