From fc1384bdcf0f4da687714cf7a8564780e76a3e43 Mon Sep 17 00:00:00 2001 From: Hadley Wickham Date: Fri, 6 Sep 2024 16:19:45 +0100 Subject: [PATCH] Clarify `paths` docs Fixes #543 --- R/sequential.R | 4 ++-- man/multi_req_perform.Rd | 4 ++-- man/req_perform_parallel.Rd | 4 ++-- man/req_perform_sequential.Rd | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/R/sequential.R b/R/sequential.R index 48e4873b..cda53896 100644 --- a/R/sequential.R +++ b/R/sequential.R @@ -5,8 +5,8 @@ #' has fewer limitations. #' #' @param reqs A list of [request]s. -#' @param paths An optional list of paths, if you want to download the request -#' bodies to disks. If supplied, must be the same length as `reqs`. +#' @param paths An optional character vector of paths, if you want to download +#' the request bodies to disk. If supplied, must be the same length as `reqs`. #' @param on_error What should happen if one of the requests fails? #' #' * `stop`, the default: stop iterating with an error. diff --git a/man/multi_req_perform.Rd b/man/multi_req_perform.Rd index 27adc4f4..a178c021 100644 --- a/man/multi_req_perform.Rd +++ b/man/multi_req_perform.Rd @@ -9,8 +9,8 @@ multi_req_perform(reqs, paths = NULL, pool = NULL, cancel_on_error = FALSE) \arguments{ \item{reqs}{A list of \link{request}s.} -\item{paths}{An optional list of paths, if you want to download the request -bodies to disks. If supplied, must be the same length as \code{reqs}.} +\item{paths}{An optional character vector of paths, if you want to download +the request bodies to disk. If supplied, must be the same length as \code{reqs}.} \item{pool}{Optionally, a curl pool made by \code{\link[curl:multi]{curl::new_pool()}}. Supply this if you want to override the defaults for total concurrent connections diff --git a/man/req_perform_parallel.Rd b/man/req_perform_parallel.Rd index 5b59c87a..e6dfb5e2 100644 --- a/man/req_perform_parallel.Rd +++ b/man/req_perform_parallel.Rd @@ -15,8 +15,8 @@ req_perform_parallel( \arguments{ \item{reqs}{A list of \link{request}s.} -\item{paths}{An optional list of paths, if you want to download the request -bodies to disks. If supplied, must be the same length as \code{reqs}.} +\item{paths}{An optional character vector of paths, if you want to download +the request bodies to disk. If supplied, must be the same length as \code{reqs}.} \item{pool}{Optionally, a curl pool made by \code{\link[curl:multi]{curl::new_pool()}}. Supply this if you want to override the defaults for total concurrent connections diff --git a/man/req_perform_sequential.Rd b/man/req_perform_sequential.Rd index a5752d80..c5d1334f 100644 --- a/man/req_perform_sequential.Rd +++ b/man/req_perform_sequential.Rd @@ -14,8 +14,8 @@ req_perform_sequential( \arguments{ \item{reqs}{A list of \link{request}s.} -\item{paths}{An optional list of paths, if you want to download the request -bodies to disks. If supplied, must be the same length as \code{reqs}.} +\item{paths}{An optional character vector of paths, if you want to download +the request bodies to disk. If supplied, must be the same length as \code{reqs}.} \item{on_error}{What should happen if one of the requests fails? \itemize{