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

index 863aa2f2ba2869c7f9d32a43f21b4f944a39edcd..ec7400ead4a8b79e08a274bb2622787550876dba 100644 (file)
@@ -3670,18 +3670,27 @@ class API:
 
         A WOEID is a Yahoo! Where On Earth ID.
 
-        :param lat: If provided with a long parameter the available trend
-            locations will be sorted by distance, nearest to furthest, to the
-            co-ordinate pair. The valid ranges for longitude is -180.0 to
-            +180.0 (West is negative, East is positive) inclusive.
-        :param long: If provided with a lat parameter the available trend
-            locations will be sorted by distance, nearest to furthest, to the
-            co-ordinate pair. The valid ranges for longitude is -180.0 to
-            +180.0 (West is negative, East is positive) inclusive.
+        Parameters
+        ----------
+        lat
+            If provided with a long parameter the available trend locations
+            will be sorted by distance, nearest to furthest, to the co-ordinate
+            pair. The valid ranges for longitude is -180.0 to +180.0 (West is
+            negative, East is positive) inclusive.
+        long
+            If provided with a lat parameter the available trend locations will
+            be sorted by distance, nearest to furthest, to the co-ordinate
+            pair. The valid ranges for longitude is -180.0 to +180.0 (West is
+            negative, East is positive) inclusive.
 
-        :rtype: :class:`JSON` object
+        Returns
+        -------
+        :class:`dict`
+            JSON
 
-        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/trends/locations-with-trending-topics/api-reference/get-trends-closest
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/trends/locations-with-trending-topics/api-reference/get-trends-closest
         """
         return self.request(
             'GET', 'trends/closest', endpoint_parameters=(