Fix documentation warnings, make CsvExecBuilder and Unparsed pub (apa…

…che#11729)

* Fix documentation warnings, make CsvExecBuilder and Unparsed pub

* Update datafusion/functions-aggregate/src/string_agg.rs

Co-authored-by: Jonah Gao <jonahgao@msn.com>

---------

Co-authored-by: Jonah Gao <jonahgao@msn.com>

.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

datafusion/common/src/error.rs

@@ -321,7 +321,8 @@ impl From<DataFusionError> 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`]
     ///

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,

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)

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;

datafusion/optimizer/src/simplify_expressions/expr_simplifier.rs

@@ -289,7 +289,7 @@ impl<S: SimplifyInfo> ExprSimplifier<S> {
         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

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<u64>`.
 ///

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<Unparsed> {
         match expr {
             Expr::Sort(Sort {

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