-
Notifications
You must be signed in to change notification settings - Fork 3.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
MINOR: [Documentation][C++][Python][R] Clarify docstrings around max_chunksize #40251
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! I think you may need to run devtools::document()
for R, though.
Ah, yep. Thanks @paleolimbot. That's done now. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
After merging your PR, Conbench analyzed the 7 benchmarking runs that have been run so far on merge-commit 06d841e. There were no benchmark performance regressions. 🎉 The full Conbench report has more details. |
…chunksize (apache#40251) ### Rationale for this change A user [ran into confusion](https://lists.apache.org/thread/8ym8r1z5gys7dpcr8rw8dvjbkqc2lf7f) over the units of the `max_chunksize` argument in PyArrow and didn't see any reason not to make the documentation more explicit. ### What changes are included in this PR? Just changes to docstrings. ### Are these changes tested? No, though I did go through every change to see if it was correct and I'm pretty sure it's right. Good to double-check during review though. ### Are there any user-facing changes? Just docs. Authored-by: Bryce Mecum <[email protected]> Signed-off-by: Joris Van den Bossche <[email protected]>
…chunksize (#40251) ### Rationale for this change A user [ran into confusion](https://lists.apache.org/thread/8ym8r1z5gys7dpcr8rw8dvjbkqc2lf7f) over the units of the `max_chunksize` argument in PyArrow and didn't see any reason not to make the documentation more explicit. ### What changes are included in this PR? Just changes to docstrings. ### Are these changes tested? No, though I did go through every change to see if it was correct and I'm pretty sure it's right. Good to double-check during review though. ### Are there any user-facing changes? Just docs. Authored-by: Bryce Mecum <[email protected]> Signed-off-by: Joris Van den Bossche <[email protected]>
…chunksize (apache#40251) ### Rationale for this change A user [ran into confusion](https://lists.apache.org/thread/8ym8r1z5gys7dpcr8rw8dvjbkqc2lf7f) over the units of the `max_chunksize` argument in PyArrow and didn't see any reason not to make the documentation more explicit. ### What changes are included in this PR? Just changes to docstrings. ### Are these changes tested? No, though I did go through every change to see if it was correct and I'm pretty sure it's right. Good to double-check during review though. ### Are there any user-facing changes? Just docs. Authored-by: Bryce Mecum <[email protected]> Signed-off-by: Joris Van den Bossche <[email protected]>
Rationale for this change
A user ran into confusion over the units of the
max_chunksize
argument in PyArrow and didn't see any reason not to make the documentation more explicit.What changes are included in this PR?
Just changes to docstrings.
Are these changes tested?
No, though I did go through every change to see if it was correct and I'm pretty sure it's right. Good to double-check during review though.
Are there any user-facing changes?
Just docs.