hadrian-reppas opened a new pull request, #46898:
URL: https://github.com/apache/arrow/pull/46898

   ### 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:
   1. In the doc for the `on` parameter, 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.
   2. In the doc for the `tolerance` parameter, it says "A right row is 
considered a match with the left row `right.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-negative `tolerance`s.
   
   ### 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.
   


-- 
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-unsubscr...@arrow.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to