Use @param \ldots everywhere

Author: HenrikBengtsson

R/backend_api-ClusterFutureBackend-class.R

@@ -42,7 +42,7 @@
 #' @param persistent If FALSE, the evaluation environment is cleared
 #' from objects prior to the evaluation of the future.
 #' 
-#' @param \dots Additional named elements passed to [Future()].
+#' @param \ldots Additional named elements passed to [Future()].
 #'
 #' @return
 #' A ClusterFuture.

R/backend_api-Future-class.R

@@ -80,7 +80,7 @@
 #'
 #' @param label An optional character string label attached to the future.
 #'
-#' @param \dots Additional named elements of the future.
+#' @param \ldots Additional named elements of the future.
 #' 
 #' @return
 #' `Future()` returns an object of class `Future`.
@@ -383,7 +383,7 @@ assertOwner <- local({
 #' Run a future
 #'
 #' @param future A \link{Future}.
-#' @param \dots Not used.
+#' @param \ldots Not used.
 #'
 #' @return The [Future] object.
 #'
@@ -583,7 +583,7 @@ result <- function(future, ...) {
 #' Get the results of a resolved future
 #'
 #' @param future A \link{Future}.
-#' @param \dots Not used.
+#' @param \ldots Not used.
 #'
 #' @return The [FutureResult] object.
 #'
@@ -882,7 +882,7 @@ getFutureData <- function(future, ..., debug = isTRUE(getOption("future.debug"))
 #' Inject code for the next type of future to use for nested futures
 #'
 #' @param future Current future.
-#' @param \dots Not used.
+#' @param \ldots Not used.
 #'
 #' @return A future expression with code injected to set what
 #' type of future to use for nested futures, iff any.

R/backend_api-MulticoreFutureBackend-class.R

@@ -24,6 +24,8 @@
 #' If a function, it is called without arguments _when the future
 #' is created_ and its value is used to configure the workers.
 #'
+#' @param \ldots Additional named elements to [Future()].
+#'
 #' @return
 #' A [Future].
 #' If `workers == 1`, then all processing using done in the

R/backend_api-MultiprocessFutureBackend-class.R

@@ -25,7 +25,7 @@ nbrOfFreeWorkers.MultiprocessFutureBackend <- function(evaluator, background = F
 #'
 #' @inheritParams Future-class
 #' 
-#' @param \dots Additional named elements passed to [Future()].
+#' @param \ldots Additional named elements passed to [Future()].
 #'
 #' @return
 #' `MultiprocessFuture()` returns an object of class `MultiprocessFuture`.

R/backend_api-MultisessionFutureBackend-class.R

@@ -23,7 +23,7 @@
 #' @inheritParams Future-class
 #' @inheritParams future
 #' 
-#' @param \dots Additional arguments passed to [Future()].
+#' @param \ldots Additional arguments passed to [Future()].
 #'
 #' @param rscript_libs A character vector of \R package library folders that
 #' the workers should use.  The default is `.libPaths()` so that multisession

R/backend_api-SequentialFutureBackend-class.R

@@ -17,6 +17,8 @@
 #' @inheritParams future
 #' @inheritParams Future-class
 #' 
+#' @param \ldots Additional named elements to [Future()].
+#'
 #' @return
 #' A [Future].
 #'

R/backend_api-UniprocessFuture-class.R

@@ -2,7 +2,7 @@
 #'
 #' @inheritParams Future-class
 #' 
-#' @param \dots Additional named elements passed to [Future()].
+#' @param \ldots Additional named elements passed to [Future()].
 #'
 #' @return
 #' `UniprocessFuture()` returns an object of class `UniprocessFuture`.

R/core_api-future.R

@@ -16,7 +16,7 @@
 #' 
 #' @param expr,value An \R \link[base]{expression}.
 #'
-#' @param \dots Additional arguments passed to [Future()].
+#' @param \ldots Additional arguments passed to [Future()].
 #'
 #' @return
 #' `f <- future(expr)` creates a [Future] `f` that evaluates expression `expr`, the value of the future is retrieved using `v <- value(f)`.

R/core_api-resolved.R

@@ -3,7 +3,7 @@
 #' @param x A \link{Future}, a list, or an environment (which also
 #' includes \link[listenv:listenv]{list environment}).
 #'
-#' @param \dots Not used.
+#' @param \ldots Not used.
 #'
 #' @return A logical of the same length and dimensions as `x`.
 #' Each element is TRUE unless the corresponding element is a

R/core_api-value.R

@@ -13,7 +13,7 @@
 #' @param signal If TRUE, \link[base]{conditions} captured while resolving
 #' futures are relayed, otherwise not.
 #' 
-#' @param \dots All arguments used by the S3 methods.
+#' @param \ldots All arguments used by the S3 methods.
 #'
 #' @return
 #' `value()` of a Future object returns the value of the future, which can