[arrow] branch main updated: MINOR: [R] Make description of to_arrow function more specific (#36261)

[th...@apache.org]

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

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


The following commit(s) were added to refs/heads/main by this push:
     new dd1b723eec MINOR: [R] Make description of to_arrow function more specific (#36261)
dd1b723eec is described below

commit dd1b723eec062a83796b76a926c8df476963fb04
Author: Nic Crane <th...@gmail.com>
AuthorDate: Fri Jun 23 14:09:55 2023 +0100

    MINOR: [R] Make description of to_arrow function more specific (#36261)
    
    The purpose of this function is for working with DuckDB connection objects, and while the comments allude to possible future adaptations to work with other objects, we should document the current purpose now and update the docs if we do support alternatives in future.
    
    Authored-by: Nic Crane <th...@gmail.com>
    Signed-off-by: Nic Crane <th...@gmail.com>
---
 r/R/duckdb.R      | 5 ++---
 r/man/to_arrow.Rd | 5 ++---
 2 files changed, 4 insertions(+), 6 deletions(-)

diff --git a/r/R/duckdb.R b/r/R/duckdb.R
index a3e4efdee9..f587ff4d82 100644
--- a/r/R/duckdb.R
+++ b/r/R/duckdb.R
@@ -116,10 +116,9 @@ duckdb_disconnector <- function(con, tbl_name) {
   environment()
 }
 
-#' Create an Arrow object from others
+#' Create an Arrow object from a DuckDB connection
 #'
-#' This can be used in pipelines that pass data back and forth between Arrow and
-#' other processes (like DuckDB).
+#' This can be used in pipelines that pass data back and forth between Arrow and DuckDB
 #'
 #' @param .data the object to be converted
 #' @return A `RecordBatchReader`.
diff --git a/r/man/to_arrow.Rd b/r/man/to_arrow.Rd
index ad534b0696..aed40609a5 100644
--- a/r/man/to_arrow.Rd
+++ b/r/man/to_arrow.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/duckdb.R
 \name{to_arrow}
 \alias{to_arrow}
-\title{Create an Arrow object from others}
+\title{Create an Arrow object from a DuckDB connection}
 \usage{
 to_arrow(.data)
 }
@@ -13,8 +13,7 @@ to_arrow(.data)
 A \code{RecordBatchReader}.
 }
 \description{
-This can be used in pipelines that pass data back and forth between Arrow and
-other processes (like DuckDB).
+This can be used in pipelines that pass data back and forth between Arrow and DuckDB
 }
 \examples{
 \dontshow{if (getFromNamespace("run_duckdb_examples", "arrow")()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}