From 14ed86466d754a24486daef491434a9e17db094f Mon Sep 17 00:00:00 2001 From: Harmon Date: Tue, 25 May 2021 06:07:50 -0500 Subject: [PATCH] Update and improve documentation for API.update_profile_banner --- tweepy/api.py | 42 ++++++++++++++++++++++++++---------------- 1 file changed, 26 insertions(+), 16 deletions(-) diff --git a/tweepy/api.py b/tweepy/api.py index 8660983..daf1a5a 100644 --- a/tweepy/api.py +++ b/tweepy/api.py @@ -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: -- 2.25.1