docs: rework example in run_bin

luciorq · Dec 4, 2024 · c6fa3b4 · c6fa3b4
1 parent d6e17ec
commit c6fa3b4
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/R/run_bin.R b/R/run_bin.R
@@ -13,7 +13,11 @@
 #' \dontrun{
 #' # Example assumes that 'my-env' exists and contains 'python'
 #' # Run 'python' with a script in 'my-env' environment
-#' condathis::run_bin("python", "script.py", env_name = "my-env", verbose = "silent")
+#' condathis::run_bin(
+#'   "python", "-c", "import sys; print(sys.version)",
+#'   env_name = "my-env",
+#'   verbose = "output"
+#' )
 #'
 #' # Run 'ls' command with additional arguments
 #' condathis::run_bin("ls", "-la", env_name = "my-env")
@@ -27,7 +31,8 @@ run_bin <- function(
     verbose = "silent",
     error = c("cancel", "continue"),
     stdout = "|",
-    stderr = "|") {
+    stderr = "|"
+  ) {
   error <- rlang::arg_match(error)
   if (isTRUE(identical(error, "cancel"))) {
     error_var <- TRUE

diff --git a/man/run_bin.Rd b/man/run_bin.Rd