lidavidm commented on a change in pull request #12673:
URL: https://github.com/apache/arrow/pull/12673#discussion_r830642254
##########
File path: cpp/src/parquet/properties.h
##########
@@ -176,59 +176,100 @@ class PARQUET_EXPORT WriterProperties {
return this;
}
+ /**
+ * Enable dictionary encoding in general for all columns. Default enabled.
+ */
Review comment:
Thanks for doing this!
In general we use `/// Doc comment` syntax over the Javadoc style `/** */`,
if you don't mind keeping it consistent
##########
File path: cpp/src/parquet/properties.h
##########
@@ -176,59 +176,100 @@ class PARQUET_EXPORT WriterProperties {
return this;
}
Review comment:
It seems `memory_pool` could also use documentation?
##########
File path: cpp/src/parquet/properties.h
##########
@@ -351,36 +408,64 @@ class PARQUET_EXPORT WriterProperties {
return this->compression_level(path->ToDotString(), compression_level);
}
+ /**
+ * Define the file encryption properties.
+ * Default NULL.
+ */
Builder* encryption(
std::shared_ptr<FileEncryptionProperties> file_encryption_properties) {
file_encryption_properties_ = std::move(file_encryption_properties);
return this;
}
+ /**
+ * Enable statistics in general.
+ * Default enabled.
+ */
Builder* enable_statistics() {
default_column_properties_.set_statistics_enabled(true);
return this;
}
+ /**
+ * Disable statistics in general.
+ * Default enabled.
+ */
Builder* disable_statistics() {
default_column_properties_.set_statistics_enabled(false);
return this;
}
+ /**
+ * Enable statistics for the column specified by `path`.
+ * Default enabled.
+ */
Builder* enable_statistics(const std::string& path) {
statistics_enabled_[path] = true;
return this;
}
+ /**
+ * Enable statistics for the column specified by `path`.
+ * Default enabled.
+ */
Builder* enable_statistics(const std::shared_ptr<schema::ColumnPath>&
path) {
return this->enable_statistics(path->ToDotString());
}
+ /**
+ * Disable statistics for the column specified by `path`.
+ * Default enabled.
+ */
Builder* disable_statistics(const std::string& path) {
statistics_enabled_[path] = false;
return this;
}
+ /**
+ * Disable statistics for the column specified by `path`.
+ * Default enabled.
+ */
Builder* disable_statistics(const std::shared_ptr<schema::ColumnPath>&
path) {
return this->disable_statistics(path->ToDotString());
}
Review comment:
Likewise, it seems `build()` below could use a doc comment (just to make
it show up in Sphinx)?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
