From 34c7bbf77bda58b9ebc6d005a322199abc0f85a6 Mon Sep 17 00:00:00 2001 From: Nicholas Masel Date: Thu, 5 Mar 2026 11:39:14 -0500 Subject: [PATCH 1/2] corrected return documentation --- R/axecute.R | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) 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 From a1521bf03cfba218610d92e1e50d836018e65192 Mon Sep 17 00:00:00 2001 From: Nicholas Masel Date: Thu, 5 Mar 2026 11:43:41 -0500 Subject: [PATCH 2/2] add news --- NEWS.md | 2 ++ 1 file changed, 2 insertions(+) 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