Skip to content

Commit 24f0f4c

Browse files
committed
fix docstrings
1 parent caad5c5 commit 24f0f4c

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

cpp/src/parquet/properties.h

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -516,13 +516,21 @@ class PARQUET_EXPORT WriterProperties {
516516

517517
/// \brief Enable writing the path_in_schema field to ColumnMetaData in the footer.
518518
///
519-
/// Writing ....
519+
/// Writing path_in_schema is enabled by default, and should be left enabled for
520+
/// maximum file compatibility, especially with older readers that expect this field
521+
/// to be present.
520522
Builder* enable_write_path_in_schema() {
521523
write_path_in_schema_ = true;
522524
return this;
523525
}
524526

525527
/// \brief Disable writing the path_in_schema field to ColumnMetaData in the footer.
528+
///
529+
/// The path_in_schema field in the Thrift metadata is redundant and wastes a great
530+
/// deal of space. Parquet file footers can be made much smaller by omitting this
531+
/// field. Because the field was originally a mandatory field, writing of
532+
/// path_in_schema is by default enabled. If one knows that all readers one plans to
533+
/// use are tolerant of the absence of this field, writing may be safely disabled.
526534
Builder* disable_write_path_in_schema() {
527535
write_path_in_schema_ = false;
528536
return this;

0 commit comments

Comments
 (0)