Skip to content

Commit

Permalink
Clarify multi-request progress bar
Browse files Browse the repository at this point in the history
Fixes #459
  • Loading branch information
hadley committed Dec 20, 2024
1 parent c16b137 commit a5d8c5f
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 12 deletions.
8 changes: 5 additions & 3 deletions R/sequential.R
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@
#' * `return`: stop iterating, returning all the successful responses
#' received so far, as well as an error object for the failed request.
#' * `continue`: continue iterating, recording errors in the result.
#' @param progress Display a progress bar? Use `TRUE` to turn on a basic
#' progress bar, use a string to give it a name, or see [progress_bars] to
#' customise it in other ways.
#' @param progress Display a progress bar for the status of all requests? Use
#' `TRUE` to turn on a basic progress bar, use a string to give it a name,
#' or see [progress_bars] to customize it in other ways. Not compatible with
#' [req_progress()], as httr2 can only display a single progress bar at a
#' time.
#' @return
#' A list, the same length as `reqs`, containing [response]s and possibly
#' error objects, if `on_error` is `"return"` or `"continue"` and one of the
Expand Down
8 changes: 5 additions & 3 deletions man/req_perform_iterative.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 5 additions & 3 deletions man/req_perform_parallel.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 5 additions & 3 deletions man/req_perform_sequential.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit a5d8c5f

Please sign in to comment.