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

Re-export modules individually to fix rustdocs #6757

Merged
merged 4 commits into from
Jun 26, 2023

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Jun 23, 2023

Which issue does this PR close?

Closes #6648

Rationale for this change

When I am trying to use rustdocs to find certain classes it often fails to do so (see #6648 for more details)

What changes are included in this PR?

  1. Directly pub use the content of submodules rather than just the modules themselves

This means that rustdoc can now find all the classes directly:

Screenshot 2023-06-23 at 3 17 25 PM

Are these changes tested?

Existing tests

Are there any user-facing changes?

Better rust docs

@github-actions github-actions bot added the core Core DataFusion crate label Jun 23, 2023
@alamb
Copy link
Contributor Author

alamb commented Jun 23, 2023

cc @dadepo

@alamb alamb marked this pull request as ready for review June 23, 2023 19:24
@andygrove andygrove merged commit 1522e7a into apache:main Jun 26, 2023
@alamb alamb deleted the alamb/remove_pub_use branch June 26, 2023 20:29
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.

rustdoc searches don't find all relevant classes
3 participants