Update and improve documentation for API.get_list
authorHarmon <Harmon758@gmail.com>
Mon, 24 May 2021 12:28:48 +0000 (07:28 -0500)
committerHarmon <Harmon758@gmail.com>
Mon, 24 May 2021 12:28:48 +0000 (07:28 -0500)
tweepy/api.py

index 83fef8f0c12fba26af81e544edfff70600061d02..cc9ce55b6f96fe2b7aaa4f227473860dd6fdfc08 100644 (file)
@@ -1484,14 +1484,22 @@ class API:
         Returns the specified list. Private lists will only be shown if the
         authenticated user owns the specified list.
 
-        :param list_id: |list_id|
-        :param slug: |slug|
-        :param owner_screen_name: |owner_screen_name|
-        :param owner_id: |owner_id|
+        list_id
+            |list_id|
+        slug
+            |slug|
+        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/get-lists-show
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-show
         """
         return self.request(
             'GET', 'lists/show', endpoint_parameters=(