[GitHub] [arrow-rs] tustvold commented on a diff in pull request #3068: Minor: Improve docstrings on WriterPropertiesBuilder

[GitBox <gi...@apache.org>]

tustvold commented on code in PR #3068:
URL: https://github.com/apache/arrow-rs/pull/3068#discussion_r1018237629


##########
parquet/src/file/properties.rs:
##########
@@ -306,38 +306,46 @@ impl WriterPropertiesBuilder {
         self
     }
 
-    /// Sets best effort maximum size of a data page in bytes
+    /// Sets best effort maximum size of a data page in bytes.
     ///
-    /// Note: this is a best effort limit based on the write batch size
+    /// Note: this is a best effort limit based on value of
+    /// [`set_write_batch_size`](Self::set_write_batch_size).
     pub fn set_data_pagesize_limit(mut self, value: usize) -> Self {
         self.data_pagesize_limit = value;
         self
     }
 
-    /// Sets best effort maximum number of rows in a data page
+    /// Sets best effort maximum number of rows in a data page.
     ///
     ///
     /// This can be used to limit the number of rows within a page to
-    /// yield better page pruning
+    /// yield better page pruning.
     ///
-    /// Note: this is a best effort limit based on the write batch size
+    /// Note: this is a best effort limit based on value of
+    /// [`set_write_batch_size`](Self::set_write_batch_size).
     pub fn set_data_page_row_count_limit(mut self, value: usize) -> Self {
         self.data_page_row_count_limit = value;
         self
     }
 
-    /// Sets best effort maximum dictionary page size, in bytes
+    /// Sets best effort maximum dictionary page size, in bytes.
     ///
-    /// Note: this is a best effort limit based on the write batch size
+    /// Note: this is a best effort limit based on value of
+    /// [`set_write_batch_size`](Self::set_write_batch_size).
     pub fn set_dictionary_pagesize_limit(mut self, value: usize) -> Self {
         self.dictionary_pagesize_limit = value;
         self
     }
 
-    /// Sets write batch size
+    /// Sets write batch size.
+    ///
+    /// For performance reasons, data for each column is written in

Review Comment:
   Its accurate



-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org