Skip to content

Commit

Permalink
Update stdout and stderr argument docs (#283)
Browse files Browse the repository at this point in the history
  • Loading branch information
multimeric authored May 22, 2024
1 parent 80bb64d commit 9d1cfd0
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 10 deletions.
8 changes: 6 additions & 2 deletions R/eval.R
Original file line number Diff line number Diff line change
Expand Up @@ -44,17 +44,21 @@
#' 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
#' error. If nothing was sent to the standard error, then this file
#' 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
Expand Down
12 changes: 8 additions & 4 deletions man/r.Rd

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

12 changes: 8 additions & 4 deletions man/r_bg.Rd

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

0 comments on commit 9d1cfd0

Please sign in to comment.