HELP: Clarify that resolved() never signals an error, result() and value() may signal a FutureError, e.g. FutureInteruptError

Author: HenrikBengtsson

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: future
-Version: 1.67.0-9015
+Version: 1.67.0-9017
 Title: Unified Parallel and Distributed Processing in R for Everyone
 Depends:
     R (>= 3.2.0)

R/backend_api-Future-class.R

@@ -642,6 +642,9 @@ result <- function(future, ...) {
 #' @param \ldots Not used.
 #'
 #' @return The [FutureResult] object.
+#' It may signal a [FutureError], if there is a significant orchestration
+#' error. For example, if the parallel worker process terminated abruptly
+#' ("crashed"), then a [FutureInterruptError] is signaled.
 #'
 #' @details
 #' This function is only part of the _backend_ Future API.

R/core_api-resolved.R

@@ -12,6 +12,7 @@
 #' A logical vector of the same length and dimensions as `x`.
 #' Each element is TRUE unless the corresponding element is a
 #' non-resolved future in case it is FALSE.
+#' It never signals an error.
 #'
 #' @details
 #' `resolved(..., run = TRUE)` attempts to launch a lazy future, if there is

R/core_api-value.R

@@ -44,6 +44,8 @@
 #' If `signal` is TRUE and one of the futures produces an error, then
 #' that error is relayed. Any remaining, non-resolved futures in `x` are
 #' canceled, prior to signaling such an error.
+#' If the future was interrupted, canceled, or the parallel worker terminated
+#' abruptly ("crashed"), then a [FutureInterruptError] is signaled.
 #'
 #' @example incl/value.R
 #'