siddubakka opened a new pull request, #12322: URL: https://github.com/apache/arrow-rs/pull/12322
# Which issue does this PR close? - Closes #10931 # Rationale for this change The setters for the page limits already say they are best effort and that they are checked between batches, but how they relate to each other is only spelled out in one place, and that place does not cover the case this issue was filed about. A reader who lowers a page limit and still sees a larger page has to go read the column writer to find out why. This documents the behavior the writer has today. No pages are cut differently. # What changes are included in this PR? A "Page limits and batch size" section on `WriterProperties`. It explains that page limits are best effort, that `write_batch_size` is the granularity at which they are checked, and that a batch whose definition and repetition levels are all the same value is written at `data_page_row_count_limit` instead. Each of the four setters links to that section. It also fixes a duplicated "such as such as" in `set_write_batch_size`. # Are these changes tested? This is a documentation only change, so there is no behavior to test. The generated docs build without warnings from this file and the new links land on the new section. # Are there any significant user-facing changes? No. No API or behavior changes, only rustdoc text. # AI usage disclosure I used an AI assistant to draft the documentation change and this description. The parquet test suite and clippy were run locally before opening this PR. -- 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]
