Update and improve documentation for API.rate_limit_status

Automatically use docstring for documentation
Change API documentation header to match API reference index
Add documentation for resources parameter

diff --git a/docs/api.rst b/docs/api.rst
index d64e87a83d403fdcd8e2b8c85d1e3eeb0ac83eb5..8a082ae0e53e04458e86818eaf1dd7cb078ad95a 100644 (file)
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -268,19 +268,10 @@ Get Twitter supported languages
 
 .. automethod:: API.supported_languages
 
+Get app rate limit status
+^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Account Methods
----------------
-
-.. method:: API.rate_limit_status()
-
-   Returns the current rate limits for methods belonging to the specified
-   resource families. When using application-only auth, this method's response
-   indicates the application-only auth rate limiting context.
-
-   :param resources: A comma-separated list of resource families you want to
-                     know the current rate limit disposition for.
-   :rtype: :class:`JSON` object
+.. automethod:: API.rate_limit_status
 
 
 Search Methods

diff --git a/tweepy/api.py b/tweepy/api.py
index 9f3146a60d00991d9d1de0607d5bb4b68e5c1db5..6682d42aeee91b4a091f03b4f7d4a2ae168331b8 100644 (file)
--- a/tweepy/api.py
+++ b/tweepy/api.py
@@ -2807,9 +2807,22 @@ class API:
         """
         return self.request('GET', 'help/languages', **kwargs)
 
+    # Get app rate limit status
+
     @payload('json')
     def rate_limit_status(self, **kwargs):
-        """ :reference: https://developer.twitter.com/en/docs/twitter-api/v1/developer-utilities/rate-limit-status/api-reference/get-application-rate_limit_status
+        """rate_limit_status(*, resources)
+
+        Returns the current rate limits for methods belonging to the specified
+        resource families. When using application-only auth, this method's
+        response indicates the application-only auth rate limiting context.
+
+        :param resources: A comma-separated list of resource families you want
+                          to know the current rate limit disposition for.
+
+        :rtype: :class:`JSON` object
+
+        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/developer-utilities/rate-limit-status/api-reference/get-application-rate_limit_status
         """
         return self.request(
             'GET', 'application/rate_limit_status', endpoint_parameters=(