Merge pull request #189 from rstudio/pool-checkout-doc-tweaks

Recommend against poolCheckout for DBI

R/pool-methods.R

@@ -78,11 +78,18 @@ setMethod("poolClose", "Pool", function(pool) {
 #' Note that validation is only performed when the object is checked out,
 #' so you generally want to keep the checked out around for as little time as
 #' possible.
+#' 
+#' When pooling DBI database connections, you normally would not use
+#' `poolCheckout()`. Instead, for single-shot queries, treat the pool object
+#' itself as the DBI connection object and it will perform checkout/return for
+#' you. And for transactions, use [poolWithTransaction()].
 #'
 #' @param pool The pool to get the object from.
 #' @export
 #' @examples
 #' pool <- dbPool(RSQLite::SQLite())
+#' # For illustration only. You normally would not explicitly use
+#' # poolCheckout with a DBI connection pool (see Description).
 #' con <- poolCheckout(pool)
 #' con
 #' poolReturn(con)