Skip to content

Closes #251 corrected return documentation #288

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.

Sign up for GitHub

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

Merged
kodesiba merged 3 commits into from
Mar 13, 2026
Merged

Closes #251 corrected return documentation #288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
34c7bbf
corrected return documentation
nicholas-masel Mar 5, 2026
a1521bf
add news
nicholas-masel Mar 5, 2026
3b3ed2d
Merge branch 'main' into 251-bug-return-value-of-axecute-seems-to-be-…
kodesiba Mar 13, 2026
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
2 changes: 2 additions & 0 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

## Documentation

- Updated `axecute()` documentation to correctly reflect return behavior (#288)

# logrx 0.4.0

## New Features
Expand Down
6 changes: 3 additions & 3 deletions R/axecute.R
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down
Loading