Cleanup future backend arguments - 2

Author: HenrikBengtsson

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: future
-Version: 1.58.0-9022
+Version: 1.58.0-9023
 Title: Unified Parallel and Distributed Processing in R for Everyone
 Depends:
     R (>= 3.2.0)
@@ -45,3 +45,75 @@ Language: en-US
 Encoding: UTF-8
 RoxygenNote: 7.3.2
 Roxygen: list(markdown = TRUE)
+Collate: 
+    '000.bquote.R'
+    '000.import.R'
+    '000.re-exports.R'
+    '010.tweakable.R'
+    '010.utils-parallelly.R'
+    'backend_api-01-FutureBackend-class.R'
+    'backend_api-03.MultiprocessFutureBackend-class.R'
+    'backend_api-11.ClusterFutureBackend-class.R'
+    'backend_api-11.MulticoreFutureBackend-class.R'
+    'backend_api-11.SequentialFutureBackend-class.R'
+    'backend_api-13.MultisessionFutureBackend-class.R'
+    'backend_api-ConstantFuture-class.R'
+    'backend_api-Future-class.R'
+    'backend_api-FutureRegistry.R'
+    'backend_api-UniprocessFuture-class.R'
+    'backend_api-evalFuture.R'
+    'core_api-cancel.R'
+    'core_api-future.R'
+    'core_api-reset.R'
+    'core_api-resolved.R'
+    'core_api-value.R'
+    'delayed_api-futureAssign.R'
+    'delayed_api-futureOf.R'
+    'demo_api-mandelbrot.R'
+    'infix_api-01-futureAssign_OP.R'
+    'infix_api-02-globals_OP.R'
+    'infix_api-03-seed_OP.R'
+    'infix_api-04-stdout_OP.R'
+    'infix_api-05-conditions_OP.R'
+    'infix_api-06-lazy_OP.R'
+    'infix_api-07-label_OP.R'
+    'infix_api-08-plan_OP.R'
+    'infix_api-09-tweak_OP.R'
+    'protected_api-FutureCondition-class.R'
+    'protected_api-FutureGlobals-class.R'
+    'protected_api-FutureResult-class.R'
+    'protected_api-futures.R'
+    'protected_api-globals.R'
+    'protected_api-journal.R'
+    'protected_api-resolve.R'
+    'protected_api-signalConditions.R'
+    'testme.R'
+    'utils-basic.R'
+    'utils-conditions.R'
+    'utils-connections.R'
+    'utils-debug.R'
+    'utils-immediateCondition.R'
+    'utils-marshalling.R'
+    'utils-objectSize.R'
+    'utils-options.R'
+    'utils-prune_pkg_code.R'
+    'utils-registerClusterTypes.R'
+    'utils-rng_utils.R'
+    'utils-signalEarly.R'
+    'utils-stealth_sample.R'
+    'utils-sticky_globals.R'
+    'utils-tweakExpression.R'
+    'utils-uuid.R'
+    'utils-whichIndex.R'
+    'utils_api-backtrace.R'
+    'utils_api-capture_journals.R'
+    'utils_api-futureCall.R'
+    'utils_api-futureSessionInfo.R'
+    'utils_api-makeClusterFuture.R'
+    'utils_api-minifuture.R'
+    'utils_api-nbrOfWorkers.R'
+    'utils_api-plan.R'
+    'utils_api-plan-with.R'
+    'utils_api-sessionDetails.R'
+    'utils_api-tweak.R'
+    'zzz.R'

R/utils_api-plan-with.R

@@ -2,12 +2,10 @@
 #'
 #' @inheritParams plan
 #'
-#' @param data The future plan to use temporarily.
+#' @param data The future plan to use temporarily, e.g. `plan(multisession)`.
 #'
 #' @param expr The R expression to be evaluated.
 #'
-#' @param \ldots Not used.
-#'
 #' @param local If TRUE, then the future plan specified by `data`
 #' is applied temporarily in the calling frame. Argument `expr` must
 #' not be specified if `local = TRUE`.
@@ -19,6 +17,7 @@
 #'
 #' @example incl/with.R
 #'
+#' @include utils_api-plan.R
 #' @rdname plan
 #' @export
 with.FutureStrategyList <- function(data, expr, ..., local = FALSE, envir = parent.frame(), .cleanup = NA) {

R/utils_api-plan.R

@@ -267,9 +267,9 @@ all.equal.FutureStrategyList <- function(target, current, ..., debug = FALSE) {
 #'
 #' @param \ldots Additional arguments overriding the default arguments
 #' of the evaluation function.  Which additional arguments are supported
-#' depends on what evaluation function is used, e.g. several support
+#' depends on which future backend is used, e.g. several support
 #' argument `workers` but not all. For details, see the individual
-#' functions of which some are linked to below.
+#' backends of which some are linked to below.
 #"
 #' @param substitute If `TRUE`, the `strategy` expression is
 #' `substitute()`:d, otherwise not.

R/utils_api-tweak.R

@@ -1,8 +1,7 @@
 #' Tweak a future function by adjusting its default arguments
 #'
-#' @param strategy An existing future function or the name of one.
-#' @param \ldots Named arguments to replace the defaults of existing
-#' arguments.
+#' @param strategy A future backend or the name of one.
+#'
 #' @param penvir The environment used when searching for a future
 #' function by its name.
 #'