Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update stdout and stderr argument docs #283

Merged
merged 1 commit into from
May 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.

Loading