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

index 52990ef9837b0d687375d5a1fda5478292c04916..60983f03e6c66978ed41813a4e8cd39a6bf1088b 100644 (file)
@@ -1754,16 +1754,28 @@ class API:
         Add a member 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: |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-create
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create
         """
         return self.request(
             'POST', 'lists/members/create', endpoint_parameters=(