Skip to content
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.

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

Minor: Update documentation about crate organization #14304

Merged
merged 2 commits into from
Jan 27, 2025

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Jan 26, 2025

Which issue does this PR close?

Rationale for this change

Recently while working with @berkaysynnada and @logan-keede got me reviewing the documentation about the crate organization and I found it a but out of date

Let's update it

What changes are included in this PR?

Update the "crate organization" documentation section, improving wording about use of the datafusion crate as well as add some new major subcrates

Are these changes tested?

By CI

Are there any user-facing changes?

Update docs, no functional change

@alamb alamb added the documentation Improvements or additions to documentation label Jan 26, 2025
@alamb alamb marked this pull request as ready for review January 26, 2025 13:00
@github-actions github-actions bot added core Core DataFusion crate and removed documentation Improvements or additions to documentation labels Jan 26, 2025
@alamb alamb added the documentation Improvements or additions to documentation label Jan 26, 2025
//!
//! * [datafusion_common]: Common traits and types
//! * [datafusion_catalog]: Catalog APIs such as [`SchemaProvider`] and [`CatalogProvider`]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

There has been quite a bit of progress towards modularizing datafusion since this section was first written ❤️

@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Jan 26, 2025
Copy link
Contributor

@comphead comphead left a comment

Choose a reason for hiding this comment

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

lgtm thanks @alamb for getting this documented

@alamb
Copy link
Contributor Author

alamb commented Jan 26, 2025

Thanks for the review and fix @comphead

@berkaysynnada berkaysynnada merged commit be56bd3 into apache:main Jan 27, 2025
25 checks passed
@alamb alamb deleted the alamb/document_crate_org branch January 27, 2025 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Core DataFusion crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants