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

index daf1a5a6c2a1c13348f8eff5a36750467645a36e..b594c3ba45722d59dc127cd93471592e383125d4 100644 (file)
@@ -2800,14 +2800,24 @@ class API:
         Update the authenticating user's profile image. Valid formats: GIF,
         JPG, or PNG
 
-        :param filename: |filename|
-        :param file: |file|
-        :param include_entities: |include_entities|
-        :param skip_status: |skip_status|
+        Parameters
+        ----------
+        filename
+            |filename|
+        file
+            |file|
+        include_entities
+            |include_entities|
+        skip_status
+            |skip_status|
 
-        :rtype: :class:`User` object
+        Returns
+        -------
+        :class:`~tweepy.models.User`
 
-        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image
         """
         if file is not None:
             files = {'image': (filename, file)}