[arrow] branch master updated: MINOR: [R][Doc] encoding setting of `read_csv_arrow`

[th...@apache.org]

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

thisisnic 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 9e9b2fec3c MINOR: [R][Doc] encoding setting of `read_csv_arrow`
9e9b2fec3c is described below

commit 9e9b2fec3ce9e8f7355e03a84f9eb8a0f745c683
Author: SHIMA Tatsuya <ts...@gmail.com>
AuthorDate: Thu May 5 10:23:08 2022 +0000

    MINOR: [R][Doc] encoding setting of `read_csv_arrow`
    
    In the documentation, the `encoding` argument was of `CsvConvertOptions`, but it is correctly of `CsvReadOptions`.
    
    I also corrected some formatting for automatic linking in the doc.
    
    Closes #13038 from eitsupi/read-option-doc
    
    Authored-by: SHIMA Tatsuya <ts...@gmail.com>
    Signed-off-by: Nic Crane <th...@gmail.com>
---
 r/R/csv.R               | 6 +++---
 r/man/CsvReadOptions.Rd | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/r/R/csv.R b/r/R/csv.R
index d7d4f5ee16..a7d6aff45e 100644
--- a/r/R/csv.R
+++ b/r/R/csv.R
@@ -346,6 +346,7 @@ CsvTableReader$create <- function(file,
 #' - `autogenerate_column_names` Logical: generate column names instead of
 #' using the first non-skipped row (the default)? If `TRUE`, column names will
 #' be "f0", "f1", ..., "fN".
+#' - `encoding` The file encoding. (default `"UTF-8"`)
 #'
 #' `CsvParseOptions$create()` takes the following arguments:
 #'
@@ -367,9 +368,9 @@ CsvTableReader$create <- function(file,
 #' - `check_utf8` Logical: check UTF8 validity of string columns? (default `TRUE`)
 #' - `null_values` character vector of recognized spellings for null values.
 #'    Analogous to the `na.strings` argument to
-#'    [`read.csv()`][utils::read.csv()] or `na` in `readr::read_csv()`.
+#'    [`read.csv()`][utils::read.csv()] or `na` in [readr::read_csv()].
 #' - `strings_can_be_null` Logical: can string / binary columns have
-#'    null values? Similar to the `quoted_na` argument to `readr::read_csv()`.
+#'    null values? Similar to the `quoted_na` argument to [readr::read_csv()].
 #'    (default `FALSE`)
 #' - `true_values` character vector of recognized spellings for `TRUE` values
 #' - `false_values` character vector of recognized spellings for `FALSE` values
@@ -392,7 +393,6 @@ CsvTableReader$create <- function(file,
 #'    (a) `NULL`, the default, which uses the ISO-8601 parser;
 #'    (b) a character vector of [strptime][base::strptime()] parse strings; or
 #'    (c) a list of [TimestampParser] objects.
-#' - `encoding` The file encoding.
 #'
 #' `TimestampParser$create()` takes an optional `format` string argument.
 #' See [`strptime()`][base::strptime()] for example syntax.
diff --git a/r/man/CsvReadOptions.Rd b/r/man/CsvReadOptions.Rd
index 3d97e8e8a6..a3cf2073ee 100644
--- a/r/man/CsvReadOptions.Rd
+++ b/r/man/CsvReadOptions.Rd
@@ -37,6 +37,7 @@ names, unless \code{autogenerate_column_names} is \code{TRUE}.
 \item \code{autogenerate_column_names} Logical: generate column names instead of
 using the first non-skipped row (the default)? If \code{TRUE}, column names will
 be "f0", "f1", ..., "fN".
+\item \code{encoding} The file encoding. (default \code{"UTF-8"})
 }
 
 \code{CsvParseOptions$create()} takes the following arguments:
@@ -60,9 +61,9 @@ generate a row of missing values (if \code{FALSE})?
 \item \code{check_utf8} Logical: check UTF8 validity of string columns? (default \code{TRUE})
 \item \code{null_values} character vector of recognized spellings for null values.
 Analogous to the \code{na.strings} argument to
-\code{\link[utils:read.table]{read.csv()}} or \code{na} in \code{readr::read_csv()}.
+\code{\link[utils:read.table]{read.csv()}} or \code{na} in \code{\link[readr:read_delim]{readr::read_csv()}}.
 \item \code{strings_can_be_null} Logical: can string / binary columns have
-null values? Similar to the \code{quoted_na} argument to \code{readr::read_csv()}.
+null values? Similar to the \code{quoted_na} argument to \code{\link[readr:read_delim]{readr::read_csv()}}.
 (default \code{FALSE})
 \item \code{true_values} character vector of recognized spellings for \code{TRUE} values
 \item \code{false_values} character vector of recognized spellings for \code{FALSE} values
@@ -85,7 +86,6 @@ starting from the beginning of this vector. Possible values are
 (a) \code{NULL}, the default, which uses the ISO-8601 parser;
 (b) a character vector of \link[base:strptime]{strptime} parse strings; or
 (c) a list of \link{TimestampParser} objects.
-\item \code{encoding} The file encoding.
 }
 
 \code{TimestampParser$create()} takes an optional \code{format} string argument.