From 08e8fe73ca8b663c361628b826361ba496374288 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=A1bor=20Cs=C3=A1rdi?= Date: Mon, 10 Feb 2025 08:34:04 +0100 Subject: [PATCH] Improve wording in docs --- R/write-parquet.R | 9 ++++++--- man/write_parquet.Rd | 10 +++++++--- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/R/write-parquet.R b/R/write-parquet.R index 69fd574..4f91993 100644 --- a/R/write-parquet.R +++ b/R/write-parquet.R @@ -37,8 +37,11 @@ #' or nanoparquet does not implement it, `write_parquet()` throws an #' error. #' -#' This version of nanoparquet supports the following encodings: -#' `PLAIN`, `PLAIN_DICTIONARY`, `RLE`, and `RLE_DICTIONARY`. +#' Currently `write_parquet()` supports the following encodings: +#' +#' - `PLAIN` for all column types, +#' - `PLAIN_DICTIONARY` and `RLE_DICTIONARY` for all column types, +#' - `RLE` for BOOLEAN columns. #' #' See [parquet-encodings] for more about encodings. #' @param metadata Additional key-value metadata to add to the file. @@ -405,4 +408,4 @@ append_parquet <- function( } else { res } -} \ No newline at end of file +} diff --git a/man/write_parquet.Rd b/man/write_parquet.Rd index 708f663..7cb56bc 100644 --- a/man/write_parquet.Rd +++ b/man/write_parquet.Rd @@ -54,8 +54,12 @@ If a specified encoding is invalid for a certain column type, or nanoparquet does not implement it, \code{write_parquet()} throws an error. -This version of nanoparquet supports the following encodings: -\code{PLAIN}, \code{PLAIN_DICTIONARY}, \code{RLE}, and \code{RLE_DICTIONARY}. +Currently \code{write_parquet()} supports the following encodings: +\itemize{ +\item \code{PLAIN} for all column types, +\item \code{PLAIN_DICTIONARY} and \code{RLE_DICTIONARY} for all column types, +\item \code{RLE} for BOOLEAN columns. +} See \link{parquet-encodings} for more about encodings.} @@ -79,7 +83,7 @@ Writes the contents of an R data frame into a Parquet file. } \details{ \code{write_parquet()} converts string columns to UTF-8 encoding by calling -\code{\link[base:enc2utf8]{base::enc2utf8()}}. It does the same for factor levels. +\code{\link[base:Encoding]{base::enc2utf8()}}. It does the same for factor levels. } \examples{ \dontshow{if (FALSE) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}