doc: Further clarify get_connection example

ssi-dk · Sep 4, 2023 · e53d7a8 · e53d7a8
1 parent 7551a07
commit e53d7a8
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 5 deletions.
diff --git a/R/connection.R b/R/connection.R
@@ -23,13 +23,14 @@
 #'  Additional parameters sent to DBI::dbConnect()
 #' @return
 #'   An object that inherits from DBIConnection driver specified in drv
-#' @examples
-#' \dontrun{
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' conn <- get_connection(drv = RSQLite::SQLite(), dbname = ":memory:")
 #'
+#' DBI::dbIsValid(conn) # TRUE
+#'
 #' close_connection(conn)
-#' }
 #'
+#' DBI::dbIsValid(conn) # FALSE
 #' @seealso [RPostgres::Postgres]
 #' @export
 get_connection <- function(drv = RPostgres::Postgres(),

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