Add documentation for API.remove_list_members
authorHarmon <Harmon758@gmail.com>
Thu, 6 Jun 2019 03:41:53 +0000 (22:41 -0500)
committerGitHub <noreply@github.com>
Thu, 6 Jun 2019 03:41:53 +0000 (22:41 -0500)
docs/api.rst

index e296085125a75628959946656e482bcba387d11d..102a387f425f8a00eceea9f2d6a3fdfdbacbba87 100644 (file)
@@ -695,6 +695,7 @@ List Methods
    :param owner_screen_name: |owner_screen_name|
    :rtype: :class:`List` object
 
+
 .. method:: API.add_list_members(list_id/slug, screen_name/user_id, [owner_id/owner_screen_name])
 
    Add up to 100 members to a list. The authenticated user must own the list to be
@@ -708,6 +709,7 @@ List Methods
    :param owner_screen_name: |owner_screen_name|
    :rtype: :class:`List` object
 
+
 .. method:: API.remove_list_member(slug, id)
 
    Removes the specified member from the list. The authenticated user
@@ -718,6 +720,20 @@ List Methods
    :rtype: :class:`List` object
 
 
+.. method:: API.remove_list_members(list_id/slug, screen_name/user_id, [owner_id/owner_screen_name])
+
+   Remove up to 100 members from a list. The authenticated user must own 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 screen_name: A comma separated list of screen names, up to 100 are allowed in a single request
+   :param user_id: A comma separated list of user IDs, up to 100 are allowed in a single request
+   :param owner_id: |owner_id|
+   :param owner_screen_name: |owner_screen_name|
+   :rtype: :class:`List` object
+
+
 .. method:: API.list_members(list_id/slug, [owner_id/owner_screen_name], [cursor])
 
    Returns the members of the specified list.