[GitHub] [arrow] wgtmac commented on a diff in pull request #36486: GH-34509: [C++][Parquet] Doc: fix comment for ArrowReaderProperties::batch_size

["wgtmac (via GitHub)" <gi...@apache.org>]

wgtmac commented on code in PR #36486:
URL: https://github.com/apache/arrow/pull/36486#discussion_r1253335258


##########
cpp/src/parquet/properties.h:
##########
@@ -817,11 +817,12 @@ class PARQUET_EXPORT ArrowReaderProperties {
     }
   }
 
-  /// \brief Set the maximum number of rows to read into a chunk or record batch.
+  /// \brief Set the maximum number of rows to read into a arrow chunk or record batch.
   ///
+  /// It's only for `arrow::RecordBatchReader` or RecordBatchGenerator.
   /// Will only be fewer rows when there are no more rows in the file.
   void set_batch_size(int64_t batch_size) { batch_size_ = batch_size; }
-  /// Return the batch size.
+  /// Return the batch size for `arrow::RecordBatchReader` or RecordBatchGenerator.

Review Comment:
   Would it be sufficient to simply say `it only applies to reading into RecordBatch`?



##########
cpp/src/parquet/properties.h:
##########
@@ -817,11 +817,12 @@ class PARQUET_EXPORT ArrowReaderProperties {
     }
   }
 
-  /// \brief Set the maximum number of rows to read into a chunk or record batch.
+  /// \brief Set the maximum number of rows to read into a arrow chunk or record batch.

Review Comment:
   ```suggestion
     /// \brief Set the maximum number of rows to read into an arrow chunk or record batch.
   ```
   
   BTW, what does arrow chunk mean?



-- 
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