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

rustdoc searches don't find all relevant classes #6648

Closed
Tracked by #3058
alamb opened this issue Jun 12, 2023 · 0 comments · Fixed by #6757
Closed
Tracked by #3058

rustdoc searches don't find all relevant classes #6648

alamb opened this issue Jun 12, 2023 · 0 comments · Fixed by #6757
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@alamb
Copy link
Contributor

alamb commented Jun 12, 2023

Describe the bug

Something is wrong with the searching function on doc.rs for datafusion.

To Reproduce

Specifically, when one searches for SqlToRel like this: https://docs.rs/datafusion/26.0.0/datafusion/?search=sqltorel

Nothing comes up:
Screenshot 2023-06-12 at 6 55 21 AM

Expected behavior

However, it is definitely documented in https://docs.rs/datafusion-sql/26.0.0/datafusion_sql/planner/struct.SqlToRel.html

(though note that is a different crate, datafusion_sql not datafusion

Additional context

@dadepo reported this on slack

I think it is a function of the fact that datafusion is broken into several different crates and unless an item like SqlToRel is re-imported into datafusion directly it doesn't show up in the rustdocs

I believe arrow-rs uses pub use submodule::* extensively to work around this problem, for example:

https://docs.rs/arrow/latest/src/arrow/compute/mod.rs.html#18-38

@alamb alamb added bug Something isn't working documentation Improvements or additions to documentation labels Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant