Update and improve documentation for API.update_list
authorHarmon <Harmon758@gmail.com>
Mon, 24 May 2021 14:14:37 +0000 (09:14 -0500)
committerHarmon <Harmon758@gmail.com>
Mon, 24 May 2021 14:14:37 +0000 (09:14 -0500)
tweepy/api.py

index 5ff20a6c9df3c4acda6b4279ed03f92dae545fa0..05bc33f0d4478d61e7dd31a810562060d1fc487f 100644 (file)
@@ -1982,17 +1982,30 @@ class API:
         Updates the specified list.
         The authenticated user must own the list to be able to update it.
 
-        :param list_id: |list_id|
-        :param slug: |slug|
-        :param name: The name for the list.
-        :param mode: |list_mode|
-        :param description: The description to give the list.
-        :param owner_screen_name: |owner_screen_name|
-        :param owner_id: |owner_id|
+        Parameters
+        ----------
+        list_id
+            |list_id|
+        slug
+            |slug|
+        name
+            The name for the list.
+        mode
+            |list_mode|
+        description
+            The description to give the list.
+        owner_screen_name
+            |owner_screen_name|
+        owner_id
+            |owner_id|
 
-        :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-update
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-update
         """
         return self.request(
             'POST', 'lists/update', endpoint_parameters=(