From 20d367758c27e9caf20d89bd518da020e3f93ea3 Mon Sep 17 00:00:00 2001 From: Harmon Date: Mon, 24 May 2021 17:05:01 -0500 Subject: [PATCH] Update and improve documentation for API.search_users --- tweepy/api.py | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/tweepy/api.py b/tweepy/api.py index 7b12de3..3e2242c 100644 --- a/tweepy/api.py +++ b/tweepy/api.py @@ -2367,14 +2367,24 @@ class API: returned by using this API (about being listed in the People Search). It is only possible to retrieve the first 1000 matches from this API. - :param q: The query to run against people search. - :param page: |page| - :param count: |count| - :param include_entities: |include_entities| + Parameters + ---------- + q + The query to run against people search. + page + |page| + count + |count| + include_entities + |include_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-users-search + References + ---------- + https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-users-search """ return self.request( 'GET', 'users/search', endpoint_parameters=( -- 2.25.1