Skip to content

Commit 1522e7a

Browse files
authored
Re-export modules individually to fix rustdocs (#6757)
* Re-export modules directly to fix rustdocs * fix * Add comments
1 parent 8c7678a commit 1522e7a

File tree

1 file changed

+39
-10
lines changed

1 file changed

+39
-10
lines changed

datafusion/core/src/lib.rs

Lines changed: 39 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -430,19 +430,48 @@ pub mod prelude;
430430
pub mod scalar;
431431
pub mod variable;
432432

433-
// re-export dependencies from arrow-rs to minimise version maintenance for crate users
433+
// re-export dependencies from arrow-rs to minimize version maintenance for crate users
434434
pub use arrow;
435435
pub use parquet;
436436

437-
// re-export DataFusion crates
438-
pub use datafusion_common as common;
439-
pub use datafusion_common::config;
440-
pub use datafusion_execution;
441-
pub use datafusion_expr as logical_expr;
442-
pub use datafusion_optimizer as optimizer;
443-
pub use datafusion_physical_expr as physical_expr;
444-
pub use datafusion_row as row;
445-
pub use datafusion_sql as sql;
437+
// re-export DataFusion sub-crates at the top level. Use `pub use *`
438+
// so that the contents of the subcrates appears in rustdocs
439+
// for details, see https://github.com/apache/arrow-datafusion/issues/6648
440+
441+
/// re-export of [`datafusion_common`] crate
442+
pub mod common {
443+
pub use datafusion_common::*;
444+
}
445+
446+
// Backwards compatibility
447+
pub use common::config;
448+
449+
// NB datafusion execution is re-exported in the `execution` module
450+
451+
/// re-export of [`datafusion_expr`] crate
452+
pub mod logical_expr {
453+
pub use datafusion_expr::*;
454+
}
455+
456+
/// re-export of [`datafusion_optimizer`] crate
457+
pub mod optimizer {
458+
pub use datafusion_optimizer::*;
459+
}
460+
461+
/// re-export of [`datafusion_physical_expr`] crate
462+
pub mod physical_expr {
463+
pub use datafusion_physical_expr::*;
464+
}
465+
466+
/// re-export of [`datafusion_row`] crate
467+
pub mod row {
468+
pub use datafusion_row::*;
469+
}
470+
471+
/// re-export of [`datafusion_sql`] crate
472+
pub mod sql {
473+
pub use datafusion_sql::*;
474+
}
446475

447476
#[cfg(test)]
448477
pub mod test;

0 commit comments

Comments
 (0)