Skip to content

Improve documentation for DataSourceExec, FileScanConfig, DataSource etc #14941

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

Merged
merged 1 commit into from
Mar 2, 2025

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Feb 28, 2025

Which issue does this PR close?

Rationale for this change

#14224 introduced a fairly substantial change to how datasource code was implemented. To assist the upgrade I think it would be nice to document the new design in code / doc comments

What changes are included in this PR?

  1. Update and expand doc comments

Are these changes tested?

Are there any user-facing changes?

By Docs CI and I built the docs locally and looked at them

There are no functional changes

@alamb alamb added the documentation Improvements or additions to documentation label Feb 28, 2025
@github-actions github-actions bot added core Core DataFusion crate and removed documentation Improvements or additions to documentation labels Feb 28, 2025
@alamb alamb added datasource Changes to the datasource crate ffi Changes to the ffi crate physical-plan Changes to the physical-plan crate and removed ffi Changes to the ffi crate physical-plan Changes to the physical-plan crate labels Feb 28, 2025
Copy link
Contributor

@berkaysynnada berkaysynnada left a comment

Choose a reason for hiding this comment

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

LGTM, thank you @alamb

@alamb alamb merged commit d07f842 into apache:main Mar 2, 2025
25 checks passed
@alamb alamb deleted the alamb/doc_datasource branch March 2, 2025 13:01
alamb added a commit to alamb/datafusion that referenced this pull request Mar 2, 2025
alamb added a commit that referenced this pull request Mar 2, 2025
@alamb alamb mentioned this pull request Mar 2, 2025
26 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Core DataFusion crate datasource Changes to the datasource crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants