Skip to content

Commit

Permalink
update docs on progress indicators and errors
Browse files Browse the repository at this point in the history
  • Loading branch information
shikokuchuo committed Jan 15, 2025
1 parent a29c984 commit 6688c70
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 19 deletions.
3 changes: 2 additions & 1 deletion R/map.R
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@
#'
#' \code{x[.progress]} collects map results whilst showing a progress bar from
#' the \CRANpkg{cli} package, if installed, with completion percentage and ETA,
#' or else a simple text progress indicator.
#' or else a simple text progress indicator. Note: if the map operation
#' completes too quickly then the progress bar may not show at all.
#'
#' \code{x[.stop]} collects map results applying early stopping, which stops at
#' the first failure and cancels remaining operations. Note: operations already
Expand Down
12 changes: 7 additions & 5 deletions R/mirai.R
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,10 @@
#' @section Errors:
#'
#' If an error occurs in evaluation, the error message is returned as a
#' character string of class \sQuote{miraiError} and \sQuote{errorValue} (the
#' stack trace is available at \code{$stack.trace} on the error object).
#' \code{\link{is_mirai_error}} may be used to test for this.
#' character string of class \sQuote{miraiError} and \sQuote{errorValue}.
#' \code{\link{is_mirai_error}} may be used to test for this. The elements of
#' the original condition are accessible via \code{$} on the error object. A
#' stack trace is also available at \code{$stack.trace}.
#'
#' If a daemon crashes or terminates unexpectedly during evaluation, an
#' \sQuote{errorValue} 19 (Connection reset) is returned.
Expand Down Expand Up @@ -524,8 +525,9 @@ is_mirai_map <- function(x) inherits(x, "mirai_map")
#'
#' Is the object a \sQuote{miraiError}. When execution in a \sQuote{mirai}
#' process fails, the error message is returned as a character string of class
#' \sQuote{miraiError} and \sQuote{errorValue}. The stack trace is available at
#' \code{$stack.trace} on the error object.
#' \sQuote{miraiError} and \sQuote{errorValue}. The elements of the original
#' condition are accessible via \code{$} on the error object. A stack trace is
#' also available at \code{$stack.trace}.
#'
#' Is the object a \sQuote{miraiInterrupt}. When an ongoing \sQuote{mirai} is
#' sent a user interrupt, it will resolve to an empty character string classed
Expand Down
7 changes: 4 additions & 3 deletions man/call_mirai.Rd

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

7 changes: 4 additions & 3 deletions man/collect_mirai.Rd

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

3 changes: 2 additions & 1 deletion man/dot-flat.Rd

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

5 changes: 3 additions & 2 deletions man/is_mirai_error.Rd

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

7 changes: 4 additions & 3 deletions man/mirai.Rd

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

3 changes: 2 additions & 1 deletion man/mirai_map.Rd

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

0 comments on commit 6688c70

Please sign in to comment.