Update and improve documentation for API.create_saved_search
authorHarmon <Harmon758@gmail.com>
Sat, 10 Apr 2021 14:34:49 +0000 (09:34 -0500)
committerHarmon <Harmon758@gmail.com>
Sat, 10 Apr 2021 14:34:49 +0000 (09:34 -0500)
Automatically use docstring for documentation
Improve method and documentation order

docs/api.rst
tweepy/api.py

index a7e6b22a4c8032d16688f518ccca10dc7ed56518..b6b13a58036e58946a8a92b131a17048c653e46c 100644 (file)
@@ -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
index 72b6d60d5198a0375b27b3862478d8a8ea9868df..31df496454b8a0c71d038f059c9d03dbb7650a07 100644 (file)
@@ -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