Update and improve documentation for API.trends_place
authorHarmon <Harmon758@gmail.com>
Thu, 27 May 2021 15:57:36 +0000 (10:57 -0500)
committerHarmon <Harmon758@gmail.com>
Thu, 27 May 2021 15:57:36 +0000 (10:57 -0500)
tweepy/api.py

index ec7400ead4a8b79e08a274bb2622787550876dba..73fed15023b44919e1a43d5bc8067fde0c20fbb6 100644 (file)
@@ -3718,15 +3718,24 @@ class API:
         The tweet_volume for the last 24 hours is also returned for many trends
         if this is available.
 
-        :param id: The Yahoo! Where On Earth ID of the location to return
-            trending information for. Global information is available by using
-            1 as the WOEID.
-        :param exclude: Setting this equal to hashtags will remove all hashtags
-                        from the trends list.
+        Parameters
+        ----------
+        id
+            The Yahoo! Where On Earth ID of the location to return trending
+            information for. Global information is available by using 1 as the
+            WOEID.
+        exclude
+            Setting this equal to hashtags will remove all hashtags from the
+            trends list.
 
-        :rtype: :class:`JSON` object
+        Returns
+        -------
+        :class:`dict`
+            JSON
 
-        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/trends/trends-for-location/api-reference/get-trends-place
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/trends/trends-for-location/api-reference/get-trends-place
         """
         return self.request(
             'GET', 'trends/place', endpoint_parameters=(