Skip to content

docs: Improve documentation for SortKeyWalk - #27234

Closed
alamb wants to merge 16 commits into
apache:mainfrom
alamb:alamb/sort-key-walk-docs
Closed

alamb wants to merge 16 commits into
apache:mainfrom
alamb:alamb/sort-key-walk-docs

Conversation

@alamb

@alamb alamb commented Nov 8, 2026 •

Copy link
Copy Markdown
Contributor

I am doing a revamp of the docs for equivalence properties, etc

It seems SortKeyWalk was introduced in #26853

I'll break this into smaller PRs for review

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@github-actions github-actions Bot added the physical-expr Changes to the physical-expr crates label Nov 8, 2026
@alamb

alamb commented Nov 9, 2026

Copy link
Copy Markdown
Contributor Author

All content has been split out so closing this one

@alamb alamb closed this Nov 9, 2026
limadog9 pushed a commit to limadog9/datafusion that referenced this pull request Nov 11, 2026
## Which issue does this PR close?

- split out of apache#27234.

## Rationale for this change

While reviewing apache#27191 I was
researching how `EquivalenceProperties` tracks orderings, equal
expressions, constants and groupings, and wanted to write down what I
learned so others do not have to repeat it.

The concepts were documented in pieces across several structs, with no
single place that explained them together.

## What changes are included in this PR?

Rustdoc only. The `EquivalenceProperties` doc in
`datafusion/physical-expr/src/equivalence/properties/mod.rs` becomes the
hub that the other struct docs link to. It keeps the existing examples
and adds:

## What is the testing strategy for this PR?

CI

## Are there any user-facing changes?

No.

---------

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
Co-authored-by: Jay Zhan <jayzhan211@gmail.com>
STUNSLAP pushed a commit to STUNSLAP/IIIllllIIl that referenced this pull request Nov 11, 2026
…he#27237)

## Which issue does this PR close?

- N/A, documentation only.

## Rationale for this change

While reviewing apache#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`:

Split out of a larger documentation PR
(apache#27234) for easier review.

## What is the testing strategy for this PR?

CI

## Are there any user-facing changes?

No.

---------

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

physical-expr Changes to the physical-expr crates physical-plan Changes to the physical-plan crate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant