From 1f0d7c3b8b980e4cd953a8f21d58e2c5c0bf2c68 Mon Sep 17 00:00:00 2001 From: Harmon Date: Mon, 24 May 2021 07:38:38 -0500 Subject: [PATCH] Update and improve documentation for API.list_subscribers --- tweepy/api.py | 34 ++++++++++++++++++++++++---------- 1 file changed, 24 insertions(+), 10 deletions(-) diff --git a/tweepy/api.py b/tweepy/api.py index c59b830..af468dc 100644 --- a/tweepy/api.py +++ b/tweepy/api.py @@ -1568,18 +1568,32 @@ class API: Returns the subscribers of the specified list. Private list subscribers will only be shown if the authenticated user owns the specified list. - :param list_id: |list_id| - :param slug: |slug| - :param owner_screen_name: |owner_screen_name| - :param owner_id: |owner_id| - :param count: |count| - :param cursor: |cursor| - :param include_entities: |include_entities| - :param skip_status: |skip_status| + Parameters + ---------- + list_id + |list_id| + slug + |slug| + owner_screen_name + |owner_screen_name| + owner_id + |owner_id| + count + |count| + cursor + |cursor| + include_entities + |include_entities| + skip_status + |skip_status| - :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/create-manage-lists/api-reference/get-lists-subscribers + References + ---------- + https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-subscribers """ return self.request( 'GET', 'lists/subscribers', endpoint_parameters=( -- 2.25.1