Update and improve documentation for API.create_saved_search
authorHarmon <Harmon758@gmail.com>
Tue, 25 May 2021 11:11:04 +0000 (06:11 -0500)
committerHarmon <Harmon758@gmail.com>
Tue, 25 May 2021 11:11:04 +0000 (06:11 -0500)
tweepy/api.py

index b594c3ba45722d59dc127cd93471592e383125d4..ec452365903f08336ec3a1bd75462c723afa6a91 100644 (file)
@@ -2835,11 +2835,18 @@ class API:
 
         Creates a saved search for the authenticated user.
 
-        :param query: The query of the search the user would like to save.
+        Parameters
+        ----------
+        query
+            The query of the search the user would like to save.
 
-        :rtype: :class:`SavedSearch` object
+        Returns
+        -------
+        :class:`~tweepy.models.SavedSearch`
 
-        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-saved_searches-create
+        References
+        ----------
+        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=(