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

index 6a457f1fe9d4985a4a7d5605cf1d8d2de00eaf7e..9a92e17ce85b8d46104bc15c271845a68731ac95 100644 (file)
@@ -1876,18 +1876,30 @@ class API:
         the list to be able to remove members from it. Lists are limited to
         5,000 members.
 
-        :param list_id: |list_id|
-        :param slug: |slug|
-        :param user_id: A comma separated list of user IDs, up to 100 are
-                        allowed in a single request
-        :param screen_name: A comma separated list of screen names, up to 100
-                            are allowed in a single request
-        :param owner_screen_name: |owner_screen_name|
-        :param owner_id: |owner_id|
+        Parameters
+        ----------
+        list_id
+            |list_id|
+        slug
+            |slug|
+        user_id
+            A comma separated list of user IDs, up to 100 are allowed in a
+            single request
+        screen_name
+            A comma separated list of screen names, up to 100 are allowed in a
+            single request
+        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-members-destroy_all
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy_all
         """
         if 'user_id' in kwargs:
             kwargs['user_id'] = list_to_csv(kwargs['user_id'])