From a4ac0829ecf63b3640315835b1374211dfadd953 Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Thu, 1 Aug 2024 07:57:47 -0400 Subject: [PATCH] Fix documentation warnings, make CsvExecBuilder and Unparsed pub (#11729) * Fix documentation warnings, make CsvExecBuilder and Unparsed pub * Update datafusion/functions-aggregate/src/string_agg.rs Co-authored-by: Jonah Gao --------- Co-authored-by: Jonah Gao --- .github/workflows/rust.yml | 2 +- datafusion/common/src/error.rs | 3 ++- datafusion/core/src/datasource/physical_plan/mod.rs | 2 +- datafusion/core/src/datasource/physical_plan/parquet/mod.rs | 4 ++-- datafusion/functions-aggregate/src/string_agg.rs | 2 +- .../optimizer/src/simplify_expressions/expr_simplifier.rs | 2 +- datafusion/physical-plan/src/joins/utils.rs | 2 +- datafusion/sql/src/unparser/expr.rs | 5 +++-- datafusion/sql/src/unparser/mod.rs | 2 ++ 9 files changed, 14 insertions(+), 10 deletions(-) diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml index 45abeb8f6fe2..fd8c2d2090b9 100644 --- a/.github/workflows/rust.yml +++ b/.github/workflows/rust.yml @@ -234,7 +234,7 @@ jobs: rust-version: stable - name: Run cargo doc run: | - export RUSTDOCFLAGS="-D warnings -A rustdoc::private-intra-doc-links" + export RUSTDOCFLAGS="-D warnings" cargo doc --document-private-items --no-deps --workspace cd datafusion-cli cargo doc --document-private-items --no-deps diff --git a/datafusion/common/src/error.rs b/datafusion/common/src/error.rs index 58ff1121e36d..f62acaf0493b 100644 --- a/datafusion/common/src/error.rs +++ b/datafusion/common/src/error.rs @@ -321,7 +321,8 @@ impl From for io::Error { } impl DataFusionError { - const BACK_TRACE_SEP: &'static str = "\n\nbacktrace: "; + /// The separator between the error message and the backtrace + pub const BACK_TRACE_SEP: &'static str = "\n\nbacktrace: "; /// Get deepest underlying [`DataFusionError`] /// diff --git a/datafusion/core/src/datasource/physical_plan/mod.rs b/datafusion/core/src/datasource/physical_plan/mod.rs index a897895246e3..f810fb86bd89 100644 --- a/datafusion/core/src/datasource/physical_plan/mod.rs +++ b/datafusion/core/src/datasource/physical_plan/mod.rs @@ -35,7 +35,7 @@ pub use self::parquet::{ParquetExec, ParquetFileMetrics, ParquetFileReaderFactor pub use arrow_file::ArrowExec; pub use avro::AvroExec; -pub use csv::{CsvConfig, CsvExec, CsvOpener}; +pub use csv::{CsvConfig, CsvExec, CsvExecBuilder, CsvOpener}; pub use file_groups::FileGroupPartitioner; pub use file_scan_config::{ wrap_partition_type_in_dict, wrap_partition_value_in_dict, FileScanConfig, diff --git a/datafusion/core/src/datasource/physical_plan/parquet/mod.rs b/datafusion/core/src/datasource/physical_plan/parquet/mod.rs index 91e2f8866bff..72aabefba595 100644 --- a/datafusion/core/src/datasource/physical_plan/parquet/mod.rs +++ b/datafusion/core/src/datasource/physical_plan/parquet/mod.rs @@ -189,9 +189,9 @@ pub use writer::plan_to_parquet; /// # Execution Overview /// /// * Step 1: [`ParquetExec::execute`] is called, returning a [`FileStream`] -/// configured to open parquet files with a [`ParquetOpener`]. +/// configured to open parquet files with a `ParquetOpener`. /// -/// * Step 2: When the stream is polled, the [`ParquetOpener`] is called to open +/// * Step 2: When the stream is polled, the `ParquetOpener` is called to open /// the file. /// /// * Step 3: The `ParquetOpener` gets the [`ParquetMetaData`] (file metadata) diff --git a/datafusion/functions-aggregate/src/string_agg.rs b/datafusion/functions-aggregate/src/string_agg.rs index 371cc8fb9739..5d91a52bc4c6 100644 --- a/datafusion/functions-aggregate/src/string_agg.rs +++ b/datafusion/functions-aggregate/src/string_agg.rs @@ -15,7 +15,7 @@ // specific language governing permissions and limitations // under the License. -//! [`StringAgg`] and [`StringAggAccumulator`] accumulator for the `string_agg` function +//! [`StringAgg`] accumulator for the `string_agg` function use arrow::array::ArrayRef; use arrow_schema::DataType; diff --git a/datafusion/optimizer/src/simplify_expressions/expr_simplifier.rs b/datafusion/optimizer/src/simplify_expressions/expr_simplifier.rs index 38dfbb3ed551..1e1418744fb8 100644 --- a/datafusion/optimizer/src/simplify_expressions/expr_simplifier.rs +++ b/datafusion/optimizer/src/simplify_expressions/expr_simplifier.rs @@ -289,7 +289,7 @@ impl ExprSimplifier { self } - /// Should [`Canonicalizer`] be applied before simplification? + /// Should `Canonicalizer` be applied before simplification? /// /// If true (the default), the expression will be rewritten to canonical /// form before simplification. This is useful to ensure that the simplifier diff --git a/datafusion/physical-plan/src/joins/utils.rs b/datafusion/physical-plan/src/joins/utils.rs index 51744730a5a1..b8a58e4d0d30 100644 --- a/datafusion/physical-plan/src/joins/utils.rs +++ b/datafusion/physical-plan/src/joins/utils.rs @@ -66,7 +66,7 @@ use parking_lot::Mutex; /// E.g. 1 -> [3, 6, 8] indicates that the column values map to rows 3, 6 and 8 for hash value 1 /// As the key is a hash value, we need to check possible hash collisions in the probe stage /// During this stage it might be the case that a row is contained the same hashmap value, -/// but the values don't match. Those are checked in the [`equal_rows_arr`](crate::joins::hash_join::equal_rows_arr) method. +/// but the values don't match. Those are checked in the `equal_rows_arr` method. /// /// The indices (values) are stored in a separate chained list stored in the `Vec`. /// diff --git a/datafusion/sql/src/unparser/expr.rs b/datafusion/sql/src/unparser/expr.rs index e144dfd649d2..9b44848a91a8 100644 --- a/datafusion/sql/src/unparser/expr.rs +++ b/datafusion/sql/src/unparser/expr.rs @@ -522,8 +522,9 @@ impl Unparser<'_> { } } - /// This function can convert more [`Expr`] types than `expr_to_sql`, returning an [`Unparsed`] - /// like `Sort` expressions to `OrderByExpr` expressions. + /// This function can convert more [`Expr`] types than `expr_to_sql`, + /// returning an [`Unparsed`] like `Sort` expressions to `OrderByExpr` + /// expressions. pub fn expr_to_unparsed(&self, expr: &Expr) -> Result { match expr { Expr::Sort(Sort { diff --git a/datafusion/sql/src/unparser/mod.rs b/datafusion/sql/src/unparser/mod.rs index 83ae64ba238b..b2fd32566aa8 100644 --- a/datafusion/sql/src/unparser/mod.rs +++ b/datafusion/sql/src/unparser/mod.rs @@ -29,6 +29,8 @@ pub use plan::plan_to_sql; use self::dialect::{DefaultDialect, Dialect}; pub mod dialect; +pub use expr::Unparsed; + /// Convert a DataFusion [`Expr`] to [`sqlparser::ast::Expr`] /// /// See [`expr_to_sql`] for background. `Unparser` allows greater control of