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

index bf63b635844a00be9a8e20bc2bfc9f7698278256..6a457f1fe9d4985a4a7d5605cf1d8d2de00eaf7e 100644 (file)
@@ -1837,16 +1837,28 @@ class API:
         Removes the specified member from the list. The authenticated user must
         be the list's owner to remove members from the list.
 
-        :param list_id: |list_id|
-        :param slug: |slug|
-        :param user_id: |user_id|
-        :param screen_name: |screen_name|
-        :param owner_screen_name: |owner_screen_name|
-        :param owner_id: |owner_id|
+        Parameters
+        ----------
+        list_id
+            |list_id|
+        slug
+            |slug|
+        user_id
+            |user_id|
+        screen_name
+            |screen_name|
+        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
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy
         """
         return self.request(
             'POST', 'lists/members/destroy', endpoint_parameters=(