Update and improve documentation for API.get_profile_banner
authorHarmon <Harmon758@gmail.com>
Tue, 25 May 2021 10:56:15 +0000 (05:56 -0500)
committerHarmon <Harmon758@gmail.com>
Tue, 25 May 2021 10:56:15 +0000 (05:56 -0500)
tweepy/api.py

index 62291e5e4daab09a39cae01598446ecd075b2664..2d29036e6253e11e63337cbbcc71aeda8a41a865 100644 (file)
@@ -2617,12 +2617,21 @@ class API:
         The profile banner data available at each size variant's URL is in PNG
         format.
 
-        :param user_id: |user_id|
-        :param screen_name: |screen_name|
+        Parameters
+        ----------
+        user_id
+            |user_id|
+        screen_name
+            |screen_name|
 
-        :rtype: :class:`JSON` object
+        Returns
+        -------
+        :class:`dict`
+            JSON
 
-        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-users-profile_banner
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-users-profile_banner
         """
         return self.request(
             'GET', 'users/profile_banner', endpoint_parameters=(