This is an automated email from the ASF dual-hosted git repository.
mbrobbel pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/main by this push:
new b9c2bf73e7 Fix some new rustdoc warnings (#8522)
b9c2bf73e7 is described below
commit b9c2bf73e792e7cb849f0bd453059ceef45b0b74
Author: Ed Seidl <[email protected]>
AuthorDate: Wed Oct 1 00:49:17 2025 -0700
Fix some new rustdoc warnings (#8522)
# Which issue does this PR close?
None
# Rationale for this change
CI is currently failing on rustdoc as some new warnings were recently
added
# What changes are included in this PR?
Two offending lines are already guarded with `#[doc(hidden)]` so they
have been converted to regular comments.
The other warning is about referencing a private struct from a private
`new`. For this I've disabled the warning.
# Are these changes tested?
Docs only
# Are there any user-facing changes?
No
---
parquet/src/arrow/array_reader/map_array.rs | 1 +
parquet/src/arrow/arrow_reader/mod.rs | 2 +-
parquet/src/arrow/async_reader/mod.rs | 8 ++++----
3 files changed, 6 insertions(+), 5 deletions(-)
diff --git a/parquet/src/arrow/array_reader/map_array.rs
b/parquet/src/arrow/array_reader/map_array.rs
index 4bdec602ba..696dad5e3e 100644
--- a/parquet/src/arrow/array_reader/map_array.rs
+++ b/parquet/src/arrow/array_reader/map_array.rs
@@ -29,6 +29,7 @@ pub struct MapArrayReader {
}
impl MapArrayReader {
+ #[allow(rustdoc::private_intra_doc_links)]
/// Creates a new [`MapArrayReader`] with a `def_level`, `rep_level` and
`nullable`
/// as defined on [`ParquetField`][crate::arrow::schema::ParquetField]
pub fn new(
diff --git a/parquet/src/arrow/arrow_reader/mod.rs
b/parquet/src/arrow/arrow_reader/mod.rs
index 2a9fd0899e..19ba93d666 100644
--- a/parquet/src/arrow/arrow_reader/mod.rs
+++ b/parquet/src/arrow/arrow_reader/mod.rs
@@ -693,7 +693,7 @@ impl ArrowReaderMetadata {
}
#[doc(hidden)]
-/// A newtype used within [`ReaderOptionsBuilder`] to distinguish sync readers
from async
+// A newtype used within `ReaderOptionsBuilder` to distinguish sync readers
from async
pub struct SyncReader<T: ChunkReader>(T);
impl<T: Debug + ChunkReader> Debug for SyncReader<T> {
diff --git a/parquet/src/arrow/async_reader/mod.rs
b/parquet/src/arrow/async_reader/mod.rs
index 33b03fbbca..8d95c9a205 100644
--- a/parquet/src/arrow/async_reader/mod.rs
+++ b/parquet/src/arrow/async_reader/mod.rs
@@ -205,10 +205,10 @@ impl ArrowReaderMetadata {
}
#[doc(hidden)]
-/// A newtype used within [`ReaderOptionsBuilder`] to distinguish sync readers
from async
-///
-/// Allows sharing the same builder for both the sync and async versions,
whilst also not
-/// breaking the pre-existing ParquetRecordBatchStreamBuilder API
+// A newtype used within `ReaderOptionsBuilder` to distinguish sync readers
from async
+//
+// Allows sharing the same builder for both the sync and async versions,
whilst also not
+// breaking the pre-existing ParquetRecordBatchStreamBuilder API
pub struct AsyncReader<T>(T);
/// A builder for reading parquet files from an `async` source as
[`ParquetRecordBatchStream`]