From d62268d220fa46e1f3964804822573452cb277a8 Mon Sep 17 00:00:00 2001 From: Harmon Date: Mon, 26 Aug 2019 20:34:39 -0500 Subject: [PATCH] Update documentation for API.rate_limit_status Resolves #1133 --- docs/api.rst | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 97d3290..27f469d 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -366,13 +366,12 @@ Account Methods .. method:: API.rate_limit_status() - Returns the remaining number of API requests available to the - requesting user before the API limit is reached for the current - hour. Calls to rate_limit_status do not count against the rate - limit. If authentication credentials are provided, the rate limit - status for the authenticating user is returned. Otherwise, the rate - limit status for the requester's IP address is returned. + 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 -- 2.25.1