From e0f2f2628bbe2e0f56d2217f22cc18d2052464c4 Mon Sep 17 00:00:00 2001 From: Harmon Date: Mon, 24 May 2021 17:03:49 -0500 Subject: [PATCH] Update and improve documentation for API.lookup_users --- tweepy/api.py | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/tweepy/api.py b/tweepy/api.py index c8cdfec..7b12de3 100644 --- a/tweepy/api.py +++ b/tweepy/api.py @@ -2329,19 +2329,26 @@ class API: * If none of your lookup criteria can be satisfied by returning a \ user object, a HTTP 404 will be thrown. - :param screen_name: A list of screen names, up to 100 are allowed in a - single request. - :param user_id: A list of user IDs, up to 100 are allowed in a single - request. - :param include_entities: |include_entities| - :param tweet_mode: Valid request values are compat and extended, which - give compatibility mode and extended mode, - respectively for Tweets that contain over 140 - characters. + Parameters + ---------- + screen_name + A list of screen names, up to 100 are allowed in a single request. + user_id + A list of user IDs, up to 100 are allowed in a single request. + include_entities + |include_entities| + tweet_mode + Valid request values are compat and extended, which give + compatibility mode and extended mode, respectively for Tweets that + contain over 140 characters. - :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-users-lookup + References + ---------- + https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup """ return self.request( 'POST', 'users/lookup', endpoint_parameters=( -- 2.25.1