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

index 7c615f0b076c2f56222ce1e7b443b302034ecf7f..e7e37c650652f75a71178c02b73a372e8b11765e 100644 (file)
@@ -3598,14 +3598,24 @@ class API:
 
         Use this endpoint to initiate a chunked file upload session.
 
-        :param total_bytes: The size of the media being uploaded in bytes.
-        :param media_type: The MIME type of the media being uploaded.
-        :param media_category: |media_category|
-        :param additional_owners: |additional_owners|
+        Parameters
+        ----------
+        total_bytes
+            The size of the media being uploaded in bytes.
+        media_type
+            The MIME type of the media being uploaded.
+        media_category
+            |media_category|
+        additional_owners
+            |additional_owners|
 
-        :rtype: :class:`Media` object
+        Returns
+        -------
+        :class:`~tweepy.models.Media`
 
-        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload-init
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload-init
         """
         headers = {'Content-Type': 'application/x-www-form-urlencoded'}