diff --git a/NEWS.md b/NEWS.md index 32cdb556..06acc05d 100644 --- a/NEWS.md +++ b/NEWS.md @@ -8,6 +8,8 @@ ## Documentation +- Updated `axecute()` documentation to correctly reflect return behavior (#288) + # logrx 0.4.0 ## New Features diff --git a/R/axecute.R b/R/axecute.R index d9742273..08191362 100644 --- a/R/axecute.R +++ b/R/axecute.R @@ -1,7 +1,6 @@ #' Creation of a log and axecution of a file #' -#' `axecute()` creates a log, executes a file, and returns 0 if there are no -#' errors or 1 if there are any errors +#' `axecute()` executes a file and creates a log #' #' @param file String. Path to file to execute #' @param log_name String. Name of log file @@ -23,7 +22,8 @@ #' #' @importFrom purrr map_chr #' -#' @return 0 if there are no errors or 1 if there are any errors +#' @return NULL. Function is called for side effects. In non-interactive sessions, +#' exits with status 1 if errors occur and \code{quit_on_error} is TRUE. #' @export #' #' @examples