-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Fix documentation warnings, make CsvExecBuilder and Unparsed pub #11729
Changes from all commits
e080184
8a683fc
e133eff
2e11f3a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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}; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this struct, added by @connec recently, actually wasn't publically exported which was flagged by one of the doc tests |
||
pub use file_groups::FileGroupPartitioner; | ||
pub use file_scan_config::{ | ||
wrap_partition_type_in_dict, wrap_partition_value_in_dict, FileScanConfig, | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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`. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. since |
||
/// | ||
/// * 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) | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,6 +29,8 @@ pub use plan::plan_to_sql; | |
use self::dialect::{DefaultDialect, Dialect}; | ||
pub mod dialect; | ||
|
||
pub use expr::Unparsed; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Unparsed was also not pub, though maybe it does't need to be |
||
|
||
/// Convert a DataFusion [`Expr`] to [`sqlparser::ast::Expr`] | ||
/// | ||
/// See [`expr_to_sql`] for background. `Unparser` allows greater control of | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this makes all doc warnings an error and does not allow links to private items
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
RUSTDOCFLAGS
inci/scripts/rust_docs.sh
should be updated as welli am doing this in #11890