Update and improve documentation for API.create_list
authorHarmon <Harmon758@gmail.com>
Mon, 24 May 2021 13:04:40 +0000 (08:04 -0500)
committerHarmon <Harmon758@gmail.com>
Mon, 24 May 2021 13:04:40 +0000 (08:04 -0500)
tweepy/api.py

index 80b4277045cc1aa51640f954cfa95b8f492076f6..39cae2682a62d52d84c911b591a9c2e2d893e9d9 100644 (file)
@@ -1691,13 +1691,22 @@ class API:
         Creates a new list for the authenticated user.
         Note that you can create up to 1000 lists per account.
 
-        :param name: The name of the new list.
-        :param mode: |list_mode|
-        :param description: The description of the list you are creating.
+        Parameters
+        ----------
+        name
+            The name of the new list.
+        mode
+            |list_mode|
+        description
+            The description of the list you are creating.
 
-        :rtype: :class:`List` object
+        Returns
+        -------
+        :class:`~tweepy.models.List`
 
-        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-create
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-create
         """
         return self.request(
             'POST', 'lists/create', endpoint_parameters=(