[arrow] branch master updated: MINOR: [Docs] Update auto_disconnect parameter based on ARROW-14395

[jo...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

jonkeane pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git


The following commit(s) were added to refs/heads/master by this push:
     new 8295bdc2e8 MINOR: [Docs] Update auto_disconnect parameter based on ARROW-14395
8295bdc2e8 is described below

commit 8295bdc2e86e657c59724c3e56da474e5414cb39
Author: Will Jones <wi...@gmail.com>
AuthorDate: Wed Jun 1 17:20:14 2022 -0500

    MINOR: [Docs] Update auto_disconnect parameter based on ARROW-14395
    
    #11482 changed the default value of the parameter, but didn't update the docs for it.
    
    Closes #13290 from wjones127/minor-duckdb-doc
    
    Authored-by: Will Jones <wi...@gmail.com>
    Signed-off-by: Jonathan Keane <jk...@gmail.com>
---
 r/R/duckdb.R       | 6 ++----
 r/man/to_duckdb.Rd | 6 ++----
 2 files changed, 4 insertions(+), 8 deletions(-)

diff --git a/r/R/duckdb.R b/r/R/duckdb.R
index 3951362f8e..b924dafcab 100644
--- a/r/R/duckdb.R
+++ b/r/R/duckdb.R
@@ -26,9 +26,7 @@
 #' If `auto_disconnect = TRUE`, the DuckDB table that is created will be configured
 #' to be unregistered when the `tbl` object is garbage collected. This is helpful
 #' if you don't want to have extra table objects in DuckDB after you've finished
-#' using them. Currently, this cleanup can, however, sometimes lead to hangs if
-#' tables are created and deleted in quick succession, hence the default value
-#' of `FALSE`
+#' using them.
 #'
 #' @param .data the Arrow object (e.g. Dataset, Table) to use for the DuckDB table
 #' @param con a DuckDB connection to use (default will create one and store it
@@ -36,7 +34,7 @@
 #' @param table_name a name to use in DuckDB for this object. The default is a
 #' unique string `"arrow_"` followed by numbers.
 #' @param auto_disconnect should the table be automatically cleaned up when the
-#' resulting object is removed (and garbage collected)? Default: `FALSE`
+#' resulting object is removed (and garbage collected)? Default: `TRUE`
 #'
 #' @return A `tbl` of the new table in DuckDB
 #'
diff --git a/r/man/to_duckdb.Rd b/r/man/to_duckdb.Rd
index 8d6a9e5c62..79c089239b 100644
--- a/r/man/to_duckdb.Rd
+++ b/r/man/to_duckdb.Rd
@@ -21,7 +21,7 @@ in \code{options("arrow_duck_con")})}
 unique string \code{"arrow_"} followed by numbers.}
 
 \item{auto_disconnect}{should the table be automatically cleaned up when the
-resulting object is removed (and garbage collected)? Default: \code{FALSE}}
+resulting object is removed (and garbage collected)? Default: \code{TRUE}}
 }
 \value{
 A \code{tbl} of the new table in DuckDB
@@ -37,9 +37,7 @@ The result is a dbplyr-compatible object that can be used in d(b)plyr pipelines.
 If \code{auto_disconnect = TRUE}, the DuckDB table that is created will be configured
 to be unregistered when the \code{tbl} object is garbage collected. This is helpful
 if you don't want to have extra table objects in DuckDB after you've finished
-using them. Currently, this cleanup can, however, sometimes lead to hangs if
-tables are created and deleted in quick succession, hence the default value
-of \code{FALSE}
+using them.
 }
 \examples{
 \dontshow{if (getFromNamespace("run_duckdb_examples", "arrow")()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}