Skip to content

Improve DataFusion subcrate readme files #16263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jun 6, 2025
Merged

Improve DataFusion subcrate readme files #16263

merged 1 commit into from
Jun 6, 2025

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Jun 5, 2025

Which issue does this PR close?

Rationale for this change

While testing a DataFusion upgrade in delta.rs I found that that project used many of the subcrates in DataFusion directly. I made a PR to clean this up (delta-io/delta-rs#3521) but I wanted to make it easier to understand which datafusion-* crate is designed to be used directly and which is not

What changes are included in this PR?

  1. Add a note to subcrates README.md files that are not intended to be used directly
  2. Add a few missing READMEs I found while doing this

Are these changes tested?

By CI

Are there any user-facing changes?

(Hopefully) better documentation

@alamb alamb added the documentation Improvements or additions to documentation label Jun 5, 2025
@github-actions github-actions bot added sql SQL Planner logical-expr Logical plan and expressions physical-expr Changes to the physical-expr crates optimizer Optimizer rules catalog Related to the catalog crate common Related to common crate execution Related to the execution crate proto Related to proto crate functions Changes to functions implementation datasource Changes to the datasource crate physical-plan Changes to the physical-plan crate and removed documentation Improvements or additions to documentation labels Jun 5, 2025
@alamb alamb marked this pull request as ready for review June 5, 2025 16:56
andygrove
andygrove approved these changes Jun 6, 2025
View reviewed changes
Copy link
Member

@andygrove andygrove left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @alamb

@andygrove andygrove merged commit 367331e into apache:main Jun 6, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andygrove andygrove andygrove approved these changes

@blaginin blaginin blaginin approved these changes

Assignees
No one assigned
Labels
catalog Related to the catalog crate common Related to common crate datasource Changes to the datasource crate execution Related to the execution crate functions Changes to functions implementation logical-expr Logical plan and expressions optimizer Optimizer rules physical-expr Changes to the physical-expr crates physical-plan Changes to the physical-plan crate proto Related to proto crate sql SQL Planner
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@alamb @andygrove @blaginin