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

index ec452365903f08336ec3a1bd75462c723afa6a91..98c5312e809ae780ba1cabf91f708cfa71a0dd58 100644 (file)
@@ -2861,11 +2861,18 @@ class API:
         Destroys a saved search for the authenticated user. The search
         specified by ID must be owned by the authenticating user.
 
-        :param id: The ID of the saved search to be deleted.
+        Parameters
+        ----------
+        id
+            The ID of the saved search to be deleted.
 
-        :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-destroy-id
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-saved_searches-destroy-id
         """
         return self.request('POST', f'saved_searches/destroy/{id}', **kwargs)