update docs

Author: gergness

R/api.R

@@ -7,6 +7,8 @@
 #' @param status.handlers named list of specific HTTP statuses and a response
 #' function to call in the case where that status is returned. Passed to the
 #' [handleAPIresponse()] function.
+#' progress.handler an optional function that resolves errors raised
+#' during an async request. Passed to the [`pollProgress()`] function.
 #' @keywords internal
 crunchAPI <- function(http.verb, url, config = list(), status.handlers = list(), progress.handler = NULL, ...) {
     url ## force lazy eval of url
@@ -55,6 +57,8 @@ crDELETE <- function(...) crunchAPI("DELETE", ...)
 #' Do the right thing with the HTTP response
 #' @param response an httr response object
 #' @param special.statuses an optional named list of functions by status code.
+#' @param progress.handler an optional function that resolves errors raised
+#' during an async request
 #' @return The full HTTP response object, just the content, or any other
 #' status-specific action
 #' @importFrom httr content http_status

R/progress.R

@@ -6,6 +6,8 @@
 #' @param progress_url A Crunch progress URL
 #' @param wait Number of seconds to wait between polling. This time is increased
 #' 20 percent on each poll.
+#' @param error_handler An optional function that takes the status object
+#' when the progress is less than 0 (meaning the request failed)
 #' @return The percent completed of the progress. Assuming the
 #' `options(crunch.timeout)` (default: 15 minutes) hasn't been reached, this
 #' will be 100. If the timeout is reached, it will be the last reported progress