Skip to content

Commit

Permalink
MINOR: [R][Doc] encoding setting of read_csv_arrow
Browse files Browse the repository at this point in the history
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 apache#13038 from eitsupi/read-option-doc

Authored-by: SHIMA Tatsuya <[email protected]>
Signed-off-by: Nic Crane <[email protected]>
  • Loading branch information
eitsupi authored and thisisnic committed May 5, 2022
1 parent 9232ed6 commit 9e9b2fe
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions r/R/csv.R
Original file line number Diff line number Diff line change
Expand Up @@ -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:
#'
Expand All @@ -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
Expand All @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions r/man/CsvReadOptions.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 9e9b2fe

Please sign in to comment.