alamb opened a new pull request, #6869:
URL: https://github.com/apache/arrow-datafusion/pull/6869

   # Which issue does this PR close?
   N/A
   
   # Rationale for this change
   @mhilton noticed that the docs were backwards when he started looking at 
[the uses_window_frame 
docs](https://docs.rs/datafusion-expr/latest/datafusion_expr/trait.PartitionEvaluator.html#method.uses_window_frame)
   
   I spent some time researching / verifying what actually happens, and it 
turns out that  `evaluate_all` will be used when the function doesn’t use the 
window frame and I wanted to encode this learning into documentation
   
   Here is the actual code that dispatches to the different evaluation functions
   
https://github.com/apache/arrow-datafusion/blob/a1281aa79ea104efdf3d07dd1948f2ae0b374634/datafusion/physical-expr/src/window/built_in.rs#L96-L128
   
   # What changes are included in this PR?
   Update the documentation  for `PartitionEvaluator` to make what is called 
when (hopefully) clearer.
   
   I still don't understand enough of what makes a `PartitionEvaluator` 
"stateful" to document  what functions need to be implemented under what 
circumstances. Maybe @mustafarepo could help clarify this
   
   
   # Are these changes tested?
   N/A
   <!--
   We typically require tests for all PRs in order to:
   1. Prevent the code from being accidentally broken by subsequent changes
   2. Serve as another way to document the expected behavior of the code
   
   If tests are not included in your PR, please explain why (for example, are 
they covered by existing tests)?
   -->
   
   # Are there any user-facing changes?
   
   <!--
   If there are user-facing changes then we may require documentation to be 
updated before approving the PR.
   -->
   
   <!--
   If there are any breaking changes to public APIs, please add the `api 
change` label.
   -->
   
   


-- 
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]

Reply via email to