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

index 9a92e17ce85b8d46104bc15c271845a68731ac95..998d49d7ebe705a3ad12c07d39cf9339debad43d 100644 (file)
@@ -1918,14 +1918,24 @@ class API:
 
         Subscribes the authenticated user to the specified list.
 
-        :param owner_screen_name: |owner_screen_name|
-        :param owner_id: |owner_id|
-        :param list_id: |list_id|
-        :param slug: |slug|
+        Parameters
+        ----------
+        owner_screen_name
+            |owner_screen_name|
+        owner_id
+            |owner_id|
+        list_id
+            |list_id|
+        slug
+            |slug|
 
-        :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-subscribers-create
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-subscribers-create
         """
         return self.request(
             'POST', 'lists/subscribers/create', endpoint_parameters=(