Skip to content

Commit

Permalink
Improve wording in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gaborcsardi committed Feb 10, 2025
1 parent 8d9d06f commit 08e8fe7
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
9 changes: 6 additions & 3 deletions R/write-parquet.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -405,4 +408,4 @@ append_parquet <- function(
} else {
res
}
}
}
10 changes: 7 additions & 3 deletions man/write_parquet.Rd

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

0 comments on commit 08e8fe7

Please sign in to comment.