From 95a2334c26ba58578a5a8d75472833ee4c5ecbd7 Mon Sep 17 00:00:00 2001 From: Harmon Date: Sat, 10 Apr 2021 09:34:49 -0500 Subject: [PATCH] Update and improve documentation for API.create_saved_search Automatically use docstring for documentation Improve method and documentation order --- docs/api.rst | 10 ++-------- tweepy/api.py | 28 ++++++++++++++++++---------- 2 files changed, 20 insertions(+), 18 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index a7e6b22..b6b13a5 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -164,6 +164,8 @@ Manage account settings and profile .. automethod:: API.update_profile_image +.. automethod:: API.create_saved_search + Direct Message Methods ---------------------- @@ -336,14 +338,6 @@ Spam Reporting Methods Saved Searches Methods ---------------------- -.. method:: API.create_saved_search(query) - - Creates a saved search for the authenticated user. - - :param query: The query of the search the user would like to save. - :rtype: :class:`SavedSearch` object - - .. method:: API.destroy_saved_search(id) Destroys a saved search for the authenticated user. The search specified by diff --git a/tweepy/api.py b/tweepy/api.py index 72b6d60..31df496 100644 --- a/tweepy/api.py +++ b/tweepy/api.py @@ -1972,6 +1972,24 @@ class API: ), files=files, **kwargs ) + @payload('saved_search') + def create_saved_search(self, query, **kwargs): + """create_saved_search(query) + + Creates a saved search for the authenticated user. + + :param query: The query of the search the user would like to save. + + :rtype: :class:`SavedSearch` object + + :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-saved_searches-create + """ + return self.request( + 'POST', 'saved_searches/create', endpoint_parameters=( + 'query', + ), query=query, **kwargs + ) + def media_upload(self, filename, *, file=None, chunked=False, media_category=None, additional_owners=None, **kwargs): """ :reference: https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/overview @@ -2305,16 +2323,6 @@ class API: ), **kwargs ) - @payload('saved_search') - def create_saved_search(self, query, **kwargs): - """ :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-saved_searches-create - """ - return self.request( - 'POST', 'saved_searches/create', endpoint_parameters=( - 'query', - ), query=query, **kwargs - ) - @payload('saved_search') def destroy_saved_search(self, id, **kwargs): """ :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-saved_searches-destroy-id -- 2.25.1