From: Harmon <Harmon758@gmail.com>
Date: Sun, 11 Apr 2021 18:39:48 +0000 (-0500)
Subject: Update and improve documentation for API.chunked_upload
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=99747fadc2a293b6767bbd98b3405f5ae8e88f00;p=tweepy.git

Update and improve documentation for API.chunked_upload

Automatically use docstring for documentation
Improve documentation order
---

diff --git a/docs/api.rst b/docs/api.rst
index 1b6c090..69be3f7 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -217,6 +217,8 @@ Upload media
 
 .. automethod:: API.simple_upload
 
+.. automethod:: API.chunked_upload
+
 
 Account Methods
 ---------------
@@ -434,28 +436,6 @@ Utility methods
 Media methods
 -------------
 
-.. method:: API.chunked_upload(filename, [file], [file_type], \
-                               [wait_for_async_finalize], [media_category], \
-                               [additional_owners])
-
-   Use this to upload media to Twitter.
-   This uses the chunked upload endpoints and calls
-   :func:`API.chunked_upload_init`, :func:`API.chunked_upload_append`, and
-   :func:`API.chunked_upload_finalize`.
-   If ``wait_for_async_finalize`` is set, this calls
-   :func:`API.get_media_upload_status` as well.
-
-   :param filename: |filename|
-   :param file: |file|
-   :param file_type: The MIME type of the media being uploaded.
-   :param wait_for_async_finalize: Whether to wait for Twitter's API to finish
-                                   processing the media. Defaults to ``True``.
-   :param media_category: |media_category|
-   :param additional_owners: |additional_owners|
-
-   :rtype: :class:`Media` object
-
-
 .. method:: API.chunked_upload_init(total_bytes, media_type, \
                                     [media_category], [additional_owners])
 
diff --git a/tweepy/api.py b/tweepy/api.py
index 3289827..3f1f525 100644
--- a/tweepy/api.py
+++ b/tweepy/api.py
@@ -2426,7 +2426,27 @@ class API:
     def chunked_upload(self, filename, *, file=None, file_type=None,
                        wait_for_async_finalize=True, media_category=None,
                        additional_owners=None, **kwargs):
-        """ :reference https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/uploading-media/chunked-media-upload
+        """chunked_upload(filename, *, file, file_type, \
+                          wait_for_async_finalize, media_category, \
+                          additional_owners)
+
+        Use this to upload media to Twitter. This uses the chunked upload
+        endpoints and calls :func:`API.chunked_upload_init`,
+        :func:`API.chunked_upload_append`, and
+        :func:`API.chunked_upload_finalize`. If ``wait_for_async_finalize`` is
+        set, this calls :func:`API.get_media_upload_status` as well.
+
+        :param filename: |filename|
+        :param file: |file|
+        :param file_type: The MIME type of the media being uploaded.
+        :param wait_for_async_finalize: Whether to wait for Twitter's API to
+            finish processing the media. Defaults to ``True``.
+        :param media_category: |media_category|
+        :param additional_owners: |additional_owners|
+
+        :rtype: :class:`Media` object
+
+        :reference https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/uploading-media/chunked-media-upload
         """
         fp = file or open(filename, 'rb')