From: Harmon <Harmon758@gmail.com>
Date: Wed, 7 Apr 2021 15:43:04 +0000 (-0500)
Subject: Update and improve documentation for API.add_list_members
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=defe39904af3f045a921e6322485994355640d03;p=tweepy.git

Update and improve documentation for API.add_list_members

Automatically use docstring for documentation
Improve method and documentation order
Improve parameter order in documentation
---

diff --git a/docs/api.rst b/docs/api.rst
index 96317e5..8293e2a 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -96,6 +96,8 @@ Create and manage lists
 
 .. automethod:: API.add_list_member
 
+.. automethod:: API.add_list_members
+
 
 User methods
 ------------
@@ -617,23 +619,6 @@ List Methods
    :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 able to add members to 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.remove_list_member(list_id/slug, screen_name/user_id, \
                                    [owner_id/owner_screen_name])
 
diff --git a/tweepy/api.py b/tweepy/api.py
index 5897206..de18b2d 100644
--- a/tweepy/api.py
+++ b/tweepy/api.py
@@ -1220,6 +1220,39 @@ class API:
             ), **kwargs
         )
 
+    @payload('list')
+    def add_list_members(self, **kwargs):
+        """add_list_members(*, list_id, slug, user_id, screen_name, \
+                            owner_screen_name, owner_id)
+
+        Add up to 100 members to a list. The authenticated user must own the
+        list to be able to add members to 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|
+
+        :rtype: :class:`List` object
+
+        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create_all
+        """
+        if 'user_id' in kwargs:
+            kwargs['user_id'] = list_to_csv(kwargs['user_id'])
+        if 'screen_name' in kwargs:
+            kwargs['screen_name'] = list_to_csv(kwargs['screen_name'])
+        return self.request(
+            'POST', 'lists/members/create_all', endpoint_parameters=(
+                'list_id', 'slug', 'user_id', 'screen_name',
+                'owner_screen_name', 'owner_id'
+            ), **kwargs
+        )
+
     def media_upload(self, filename, *, file=None, chunked=False,
                      media_category=None, additional_owners=None, **kwargs):
         """ :reference: https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/overview
@@ -1818,21 +1851,6 @@ class API:
             ), **kwargs
         )
 
-    @payload('list')
-    def add_list_members(self, **kwargs):
-        """ :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create_all
-        """
-        if 'user_id' in kwargs:
-            kwargs['user_id'] = list_to_csv(kwargs['user_id'])
-        if 'screen_name' in kwargs:
-            kwargs['screen_name'] = list_to_csv(kwargs['screen_name'])
-        return self.request(
-            'POST', 'lists/members/create_all', endpoint_parameters=(
-                'list_id', 'slug', 'user_id', 'screen_name',
-                'owner_screen_name', 'owner_id'
-            ), **kwargs
-        )
-
     @payload('list')
     def remove_list_members(self, **kwargs):
         """ :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy_all