Skip to content

Commit

Permalink
Fix realm param description
Browse files Browse the repository at this point in the history
  • Loading branch information
salim-b authored May 16, 2024
1 parent 66a6fd0 commit 632c572
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions R/req-throttle.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@
#' Usually easiest expressed as a fraction,
#' `number_of_requests / number_of_seconds`, e.g. 15 requests per minute
#' is `15 / 60`.
#' @param realm An unique identifier that for throttle pool. If not supplied,
#' defaults to the hostname of the request.
#' @param realm A string that uniquely identifies the throttle pool to use
#' (throttling limits always apply *per pool*). If not supplied, defaults
#' to the hostname of the request.
#' @returns A modified HTTP [request].
#' @seealso [req_retry()] for another way of handling rate-limited APIs.
#' @export
Expand Down

0 comments on commit 632c572

Please sign in to comment.