From 9d1cfd05bef2af19f10a2767528ca70303635f43 Mon Sep 17 00:00:00 2001 From: Michael Milton Date: Wed, 22 May 2024 20:33:32 +1000 Subject: [PATCH] Update stdout and stderr argument docs (#283) --- R/eval.R | 8 ++++++-- man/r.Rd | 12 ++++++++---- man/r_bg.Rd | 12 ++++++++---- 3 files changed, 22 insertions(+), 10 deletions(-) diff --git a/R/eval.R b/R/eval.R index 7e4fde04..8317c515 100644 --- a/R/eval.R +++ b/R/eval.R @@ -44,8 +44,10 @@ #' then the commands are not echoed and will not be shown #' in the standard output. Also note that you need to call `print()` #' explicitly to show the output of the command(s). -#' IF `NULL` (the default), then standard output is not returned, but +#' IF `NULL`, then standard output is not returned, but #' it is recorded and included in the error object if an error happens. +#' Various special values for this argument such as `"|"` are explained +#' in the `stdout` argument of [processx::process]. #' @param stderr The name of the file the standard error of #' the child R process will be written to. #' In particular `message()` sends output to the standard @@ -53,8 +55,10 @@ #' will be empty. This argument can be the same file as `stdout`, #' in which case they will be correctly interleaved. If this is the #' string `"2>&1"`, then standard error is redirected to standard output. -#' IF `NULL` (the default), then standard output is not returned, but +#' IF `NULL`, then standard output is not returned, but #' it is recorded and included in the error object if an error happens. +#' Various special values for this argument such as `"|"` are explained +#' in the `stdout` argument of [processx::process]. #' @param error What to do if the remote process throws an error. #' See details below. #' @param poll_connection Whether to have a control connection to diff --git a/man/r.Rd b/man/r.Rd index 2c54c6c7..a61ea8a5 100644 --- a/man/r.Rd +++ b/man/r.Rd @@ -88,8 +88,10 @@ If the child process runs with the \code{--slave} option (the default), then the commands are not echoed and will not be shown in the standard output. Also note that you need to call \code{print()} explicitly to show the output of the command(s). -IF \code{NULL} (the default), then standard output is not returned, but -it is recorded and included in the error object if an error happens.} +IF \code{NULL}, then standard output is not returned, but +it is recorded and included in the error object if an error happens. +Various special values for this argument such as \code{"|"} are explained +in the \code{stdout} argument of \link[processx:process]{processx::process}.} \item{stderr}{The name of the file the standard error of the child R process will be written to. @@ -98,8 +100,10 @@ error. If nothing was sent to the standard error, then this file will be empty. This argument can be the same file as \code{stdout}, in which case they will be correctly interleaved. If this is the string \code{"2>&1"}, then standard error is redirected to standard output. -IF \code{NULL} (the default), then standard output is not returned, but -it is recorded and included in the error object if an error happens.} +IF \code{NULL}, then standard output is not returned, but +it is recorded and included in the error object if an error happens. +Various special values for this argument such as \code{"|"} are explained +in the \code{stdout} argument of \link[processx:process]{processx::process}.} \item{poll_connection}{Whether to have a control connection to the process. This is used to transmit messages from the subprocess diff --git a/man/r_bg.Rd b/man/r_bg.Rd index 17051ea4..bbbadf97 100644 --- a/man/r_bg.Rd +++ b/man/r_bg.Rd @@ -60,8 +60,10 @@ If the child process runs with the \code{--slave} option (the default), then the commands are not echoed and will not be shown in the standard output. Also note that you need to call \code{print()} explicitly to show the output of the command(s). -IF \code{NULL} (the default), then standard output is not returned, but -it is recorded and included in the error object if an error happens.} +IF \code{NULL}, then standard output is not returned, but +it is recorded and included in the error object if an error happens. +Various special values for this argument such as \code{"|"} are explained +in the \code{stdout} argument of \link[processx:process]{processx::process}.} \item{stderr}{The name of the file the standard error of the child R process will be written to. @@ -70,8 +72,10 @@ error. If nothing was sent to the standard error, then this file will be empty. This argument can be the same file as \code{stdout}, in which case they will be correctly interleaved. If this is the string \code{"2>&1"}, then standard error is redirected to standard output. -IF \code{NULL} (the default), then standard output is not returned, but -it is recorded and included in the error object if an error happens.} +IF \code{NULL}, then standard output is not returned, but +it is recorded and included in the error object if an error happens. +Various special values for this argument such as \code{"|"} are explained +in the \code{stdout} argument of \link[processx:process]{processx::process}.} \item{poll_connection}{Whether to have a control connection to the process. This is used to transmit messages from the subprocess