pitrou commented on code in PR #13799:
URL: https://github.com/apache/arrow/pull/13799#discussion_r941020156
##########
cpp/src/arrow/dataset/scanner.h:
##########
@@ -384,6 +381,23 @@ class ARROW_DS_EXPORT ScannerBuilder {
/// This option provides a control limiting the memory owned by any
RecordBatch.
Status BatchSize(int64_t batch_size);
+ /// \brief Set the number of batches to read ahead within a file.
+ ///
+ /// \param[in] batch_readahead How many batches to read ahead within a file,
+ /// might not work for all formats.
+ /// \returns An error if this number is less than 0.
+ ///
+ /// This option provides a control on RAM vs I/O tradeoff.
Review Comment:
```suggestion
/// \param[in] batch_readahead How many batches to read ahead within a
file.
/// \returns An error if this number is less than 0.
///
/// This option provides a control on RAM vs I/O tradeoff.
/// It might not be supported by all file formats, in which case it will
/// simply be ignored.
```
##########
cpp/src/arrow/dataset/scanner.h:
##########
@@ -384,6 +381,23 @@ class ARROW_DS_EXPORT ScannerBuilder {
/// This option provides a control limiting the memory owned by any
RecordBatch.
Status BatchSize(int64_t batch_size);
+ /// \brief Set the number of batches to read ahead within a file.
Review Comment:
This would make the terminology more consistent?
```suggestion
/// \brief Set the number of batches to read ahead within a fragment.
```
--
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]
