GH-46897: [Docs][C++][Python] Fix asof join documentation
Rationale for this change
The asof join documentation is currently incorrect. Here is a copy of https://github.com/apache/arrow/issues/46897 for convenience:
There are two issues with the asof join docs:
- In the doc for the
onparameter, it says "a row is considered a match if and only if left_on - tolerance <= right_on <= left_on." This is incorrect because a join with positive tolerance results in right_on values that are greater than or equal to left_on. Also, the inequality does not make sense for negative tolerances. - In the doc for the
toleranceparameter, it says "A right row is considered a match with the left rowright.on - left.on <= tolerance." This does not mention that the difference must also be greater than or equal to 0. Also, the inequality is only correct for non-negativetolerances.
What changes are included in this PR?
This PR updates the asof join documentation for pyarrow.Table, pyarrow.Dataset and acero::AsofJoinNodeOptions.
Are these changes tested?
N/A
Are there any user-facing changes?
It updates the documentation.
- GitHub Issue: #46897
:warning: GitHub issue #46897 has been automatically assigned in GitHub to PR creator.
@zanmato1984 do you have some time to review this?
I'll take a look soon.
Yeah I like that a bit better. I also updated the Python docs with the new wording.
CI failures are unrelated (seems like #47015). I'll merge later.
Thanks @hadrian-reppas a lot for fixing this!
After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit e411851738c2528a5ce24857805e0eac57e2c659.
There were no benchmark performance regressions. 🎉
The full Conbench report has more details. It also includes information about 11 possible false positives for unstable benchmarks that are known to sometimes produce them.