From 4f9b455127ad65e9c6c5a980f9a41461e17b33ec Mon Sep 17 00:00:00 2001 From: Harmon Date: Sat, 20 Feb 2021 22:16:34 -0600 Subject: [PATCH] Clarify documentation for media upload methods So as to refer to uploading media rather than only images --- docs/api.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 103e76f..4dd8ef3 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1321,7 +1321,7 @@ Media methods .. method:: API.media_upload(filename, [file], [chunked], [media_category], \ [additional_owners]) - Use this to upload images to Twitter. + Use this to upload media to Twitter. This automatically uses the chunked upload endpoints for videos. This calls either :func:`API.simple_upload` or :func:`API.chunked_upload`. @@ -1339,7 +1339,7 @@ Media methods .. method:: API.simple_upload(filename, [file], [media_category], \ [additional_owners]) - Use this endpoint to upload images to Twitter. + Use this endpoint to upload media to Twitter. This does not use the chunked upload endpoints. :param filename: |filename| @@ -1353,7 +1353,7 @@ Media methods .. method:: API.chunked_upload(filename, [file], [file_type], \ [media_category], [additional_owners]) - Use this to upload images to Twitter. + 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`. -- 2.25.1