Fix documentation warnings, make CsvExecBuilder and Unparsed pub #11729
+14
−10
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
sql
alamb
commented
Jul 30, 2024
| @@ -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" | |||
There was a problem hiding this comment.
this makes all doc warnings an error and does not allow links to private items
There was a problem hiding this comment.
RUSTDOCFLAGS in ci/scripts/rust_docs.sh should be updated as well
i am doing this in #11890
alamb
commented
Jul 30, 2024
| @@ -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.
this struct, added by @connec recently, actually wasn't publically exported which was flagged by one of the doc tests
| @@ -191,9 +191,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.
since ParquetOpener isn't public let's not try to make a link to it
| @@ -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.
Unparsed was also not pub, though maybe it does't need to be
|
Thanks @jonahgao for the review. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Closes #11728
Rationale for this change
Warnings in
cargo docsometimes mask real bugs as well as making it hard to track downcargo docerrors locally in my iDESee also #11728
What changes are included in this PR?
pubso they can be used by users (caught by doc warnings)Are these changes tested?
Are there any user-facing changes?