Update and improve documentation for API.update_profile_banner
authorHarmon <Harmon758@gmail.com>
Tue, 25 May 2021 11:07:50 +0000 (06:07 -0500)
committerHarmon <Harmon758@gmail.com>
Tue, 25 May 2021 11:07:50 +0000 (06:07 -0500)
tweepy/api.py

index 8660983d6d9f0f5e1b87780d3b13a2546b2091c5..daf1a5a6c2a1c13348f8eff5a36750467645a36e 100644 (file)
@@ -2754,22 +2754,32 @@ class API:
 
         Uploads a profile banner on behalf of the authenticating user.
 
-        :param filename: |filename|
-        :param file: |file|
-        :param width: The width of the preferred section of the image being
-            uploaded in pixels. Use with ``height``, ``offset_left``, and
-            ``offset_top`` to select the desired region of the image to use.
-        :param height: The height of the preferred section of the image being
-            uploaded in pixels. Use with ``width``, ``offset_left``, and
-            ``offset_top`` to select the desired region of the image to use.
-        :param offset_left: The number of pixels by which to offset the
-            uploaded image from the left. Use with ``height``, ``width``, and
-            ``offset_top`` to select the desired region of the image to use.
-        :param offset_top: The number of pixels by which to offset the uploaded
-            image from the top. Use with ``height``, ``width``, and
-            ``offset_left`` to select the desired region of the image to use.
-
-        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_banner
+        Parameters
+        ----------
+        filename
+            |filename|
+        file:
+            |file|
+        width
+            The width of the preferred section of the image being uploaded in
+            pixels. Use with ``height``, ``offset_left``, and ``offset_top`` to
+            select the desired region of the image to use.
+        height
+            The height of the preferred section of the image being uploaded in
+            pixels. Use with ``width``, ``offset_left``, and ``offset_top`` to
+            select the desired region of the image to use.
+        offset_left
+            The number of pixels by which to offset the uploaded image from the
+            left. Use with ``height``, ``width``, and ``offset_top`` to select
+            the desired region of the image to use.
+        offset_top
+            The number of pixels by which to offset the uploaded image from the
+            top. Use with ``height``, ``width``, and ``offset_left`` to select
+            the desired region of the image to use.
+
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_banner
         """
         with contextlib.ExitStack() as stack:
             if file is not None: