improve documentation

R/mirai.R

@@ -366,12 +366,12 @@ dispatcher <- function(host, url = NULL, n = NULL, asyncdial = FALSE,
 #' @param .expr an expression to evaluate asynchronously (of arbitrary length,
 #'     wrapped in \{\} if necessary), \strong{or} a language object passed by
 #'     \link{name}.
-#' @param ... (optional) named arguments (name = value pairs) specifying
+#' @param ... (optional) named arguments (tag = value pairs) specifying
 #'     objects referenced in '.expr'. Used in addition to, and taking precedence
 #'     over, any arguments specified via '.args'.
 #' @param .args (optional) \strong{either} a list of objects to be passed by
 #'     \link{name} (found in the current scope), \strong{or else} a list of
-#'     name = value pairs, as in '...'.
+#'     tag = value pairs, as in '...'.
 #' @param .timeout [default NULL] for no timeout, or an integer value in
 #'     milliseconds. A mirai will resolve to an 'errorValue' 5 (timed out) if
 #'     evaluation exceeds this limit.

R/pipe.R

@@ -59,8 +59,15 @@
 #'
 #'     \code{x \%>>\% f(y)} is equivalent to \code{f(x, y)}
 #'
-#'     Please note that other usage is not supported and it is not a drop-in
-#'     replacement for magrittr's \code{\%>\%} pipe.
+#'     Other usage is not supported and it is not a drop-in replacement for
+#'     magrittr's \code{\%>\%} pipe.
+#'
+#' @note The deferred evaluation pipe is generally used where the return value
+#'     of the expression is required.
+#'
+#'     For performing side effects upon resolution of a 'mirai', the promise
+#'     pipe \code{\%...>\%} may be more suitable (see the package
+#'     \pkg{mirai.promises}).
 #'
 #' @examples
 #' if (interactive()) {