Skip to content

Improve main api doc page, move avro_to_arrow to datasource #6564

New issue

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

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

Already on GitHub? # to your account

Merged
merged 6 commits into from
Jun 12, 2023

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Jun 6, 2023

Which issue does this PR close?

Related to #3058

Rationale for this change

The main docs landing page is somewhat messy and inconsistent. I would like this to be better when users try to use DataFusion

Screenshot 2023-06-06 at 9 21 53 AM

What changes are included in this PR?

Clean up docs and move the avro_to_arrow module into datasource as it is somewhat specialized

After changes:

Screenshot 2023-06-06 at 10 00 51 AM

Are these changes tested?

Are there any user-facing changes?

@github-actions github-actions bot added core Core DataFusion crate physical-expr Changes to the physical-expr crates labels Jun 6, 2023
@alamb alamb added the api change Changes the API exposed to users of the crate label Jun 6, 2023
@@ -412,7 +413,6 @@ pub const DATAFUSION_VERSION: &str = env!("CARGO_PKG_VERSION");
extern crate core;
extern crate sqlparser;

pub mod avro_to_arrow;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Technically this is a breaking API change, but I don't expect it to be a large impact as I think the use of avro_to_arrow is likely small.

If it turns out others are using it more extensively, I think we should contemplate moving it to its own crate (or maybe upstream into arrow-rs)

@alamb alamb force-pushed the alamb/clean_up_docs branch from d0f3e63 to 514113b Compare June 6, 2023 18:09
@alamb
Copy link
Contributor Author

alamb commented Jun 7, 2023

(I am in parallel working to remove FromSlice as well -- #6587)

@alamb alamb requested review from tustvold and avantgardnerio June 8, 2023 14:02
@alamb alamb changed the title Improve main api doc page Improve main api doc page, move avro_to_arrow to datasource Jun 8, 2023
Copy link
Contributor

@avantgardnerio avantgardnerio left a comment

Choose a reason for hiding this comment

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

Looks like mostly doc fixes 👍

@alamb
Copy link
Contributor Author

alamb commented Jun 11, 2023

Thanks @avantgardnerio !

@alamb alamb merged commit b8f90fe into apache:main Jun 12, 2023
@alamb alamb deleted the alamb/clean_up_docs branch June 12, 2023 10:24
jayzhan211 pushed a commit to jayzhan211/datafusion that referenced this pull request Jun 12, 2023
…he#6564)

* Improve main api doc page

* fix doc examples

* fmt
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
api change Changes the API exposed to users of the crate core Core DataFusion crate physical-expr Changes to the physical-expr crates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants