Skip to content

rustdoc searches don't find all relevant classes  #6648

@alamb

Description

@alamb

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions