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

index 9df4c1e27324dac5f8b33c4456258c5cda534a83..be28fc7e85b290fb2351ab22501c2eb32117146f 100644 (file)
@@ -1286,15 +1286,24 @@ class API:
         lists first, so with ``reverse=true``, 20 owned lists and 80
         subscriptions would be returned.
 
-        :param user_id: |user_id|
-        :param screen_name: |screen_name|
-        :param reverse: A boolean indicating if you would like owned lists to
-                        be returned first. See description above for
-                        information on how this parameter works.
+        Parameters
+        ----------
+        user_id
+            |user_id|
+        screen_name
+            |screen_name|
+        reverse
+            A boolean indicating if you would like owned lists to be returned
+            first. See description above for information on how this parameter
+            works.
 
-        :rtype: list of :class:`List` objects
+        Returns
+        -------
+        :class:`~tweepy.models.List`
 
-        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-list
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-list
         """
         return self.request(
             'GET', 'lists/list', endpoint_parameters=(