Update and improve documentation for API.list_subscribers
authorHarmon <Harmon758@gmail.com>
Mon, 24 May 2021 12:38:38 +0000 (07:38 -0500)
committerHarmon <Harmon758@gmail.com>
Mon, 24 May 2021 12:38:38 +0000 (07:38 -0500)
tweepy/api.py

index c59b8303e3d6c52e89e162b250925c3ad0e45fac..af468dc7c0b3333fd7e7c05080babb8b23b52925 100644 (file)
@@ -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=(