From e7b7d20eb3bdbd1a39291d8dfe7fc31935b471bb Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Fri, 6 Dec 2024 17:19:51 -0500 Subject: [PATCH] Add more detail to WriterPropertiesBuilder docs --- parquet/src/file/properties.rs | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/parquet/src/file/properties.rs b/parquet/src/file/properties.rs index a1a5c98bf5a..7010ca88602 100644 --- a/parquet/src/file/properties.rs +++ b/parquet/src/file/properties.rs @@ -781,9 +781,17 @@ impl WriterPropertiesBuilder { /// Should the writer coerce types to parquet native types (defaults to `false`). /// + /// Leaving this option the default `false` will ensure the exact same data + /// written to parquet using this library will be read. + /// /// Setting this option to `true` will result in parquet files that can be - /// read by more readers, but may lose precision for arrow types such as - /// [`DataType::Date64`] which have no direct corresponding Parquet type. + /// read by more readers, but potentially lose information in the process. + /// + /// * Types such as [`DataType::Date64`], which have no direct corresponding + /// Parquet type, may be stored with lower precision. + /// + /// * The internal field names of [`List`] and [`Map`] will be renamed if + /// necessary to match what is required by the newest Parquet specification. /// /// See [`ArrowToParquetSchemaConverter::with_coerce_types`] for more details ///