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

   ## Which issue does this PR close?
   
   - N/A, documentation only.
   
   ## Rationale for this change
   
   While reviewing https://github.com/apache/datafusion/pull/27191 I was 
researching how `EquivalenceProperties` tracks orderings and groupings, and 
wanted to write down what I learned so others do not have to repeat it.
   
   The `GroupingEquivalenceClass` docs described the property in prose but had 
no example, and did not say how it relates to `OrderingEquivalenceClass`, which 
it parallels.
   
   ## What changes are included in this PR?
   
   Rustdoc only, in `datafusion/physical-expr/src/equivalence/grouping.rs`:
   
   - A table example showing a table that is grouped by `[a, b]` and `[b]` but 
not sorted, and not grouped by `[a]`, to illustrate that a grouping says 
nothing about subsets of its tuple.
   - A "See also" section linking to `OrderingEquivalenceClass` (the stronger, 
sorted property) and to `EquivalenceProperties`.
   
   Split out of a larger documentation PR 
(https://github.com/apache/datafusion/pull/27234) for easier review.
   
   ## What is the testing strategy for this PR?
   
   No code changes. `cargo doc` with `-D warnings` passes, so the intra-doc 
links resolve.
   
   ## Are there any user-facing changes?
   
   No.


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


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to