Update and improve documentation for API.get_saved_search
authorHarmon <Harmon758@gmail.com>
Tue, 25 May 2021 10:54:41 +0000 (05:54 -0500)
committerHarmon <Harmon758@gmail.com>
Tue, 25 May 2021 10:54:41 +0000 (05:54 -0500)
tweepy/api.py

index d30bf859d698f771506e7321d6af08ddf5812d59..62291e5e4daab09a39cae01598446ecd075b2664 100644 (file)
@@ -2591,11 +2591,18 @@ class API:
         Retrieve the data for a saved search owned by the authenticating user
         specified by the given ID.
 
-        :param id: The ID of the saved search to be retrieved.
+        Parameters
+        ----------
+        id
+            The ID of the saved search to be retrieved.
 
-        :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/get-saved_searches-show-id
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-show-id
         """
         return self.request('GET', f'saved_searches/show/{id}', **kwargs)