Skip to content

Commit b9c2bf7

Browse files
authored
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
1 parent ef51f11 commit b9c2bf7

File tree

3 files changed

+6
-5
lines changed

3 files changed

+6
-5
lines changed

parquet/src/arrow/array_reader/map_array.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ pub struct MapArrayReader {
2929
}
3030

3131
impl MapArrayReader {
32+
#[allow(rustdoc::private_intra_doc_links)]
3233
/// Creates a new [`MapArrayReader`] with a `def_level`, `rep_level` and `nullable`
3334
/// as defined on [`ParquetField`][crate::arrow::schema::ParquetField]
3435
pub fn new(

parquet/src/arrow/arrow_reader/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -693,7 +693,7 @@ impl ArrowReaderMetadata {
693693
}
694694

695695
#[doc(hidden)]
696-
/// A newtype used within [`ReaderOptionsBuilder`] to distinguish sync readers from async
696+
// A newtype used within `ReaderOptionsBuilder` to distinguish sync readers from async
697697
pub struct SyncReader<T: ChunkReader>(T);
698698

699699
impl<T: Debug + ChunkReader> Debug for SyncReader<T> {

parquet/src/arrow/async_reader/mod.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -205,10 +205,10 @@ impl ArrowReaderMetadata {
205205
}
206206

207207
#[doc(hidden)]
208-
/// A newtype used within [`ReaderOptionsBuilder`] to distinguish sync readers from async
209-
///
210-
/// Allows sharing the same builder for both the sync and async versions, whilst also not
211-
/// breaking the pre-existing ParquetRecordBatchStreamBuilder API
208+
// A newtype used within `ReaderOptionsBuilder` to distinguish sync readers from async
209+
//
210+
// Allows sharing the same builder for both the sync and async versions, whilst also not
211+
// breaking the pre-existing ParquetRecordBatchStreamBuilder API
212212
pub struct AsyncReader<T>(T);
213213

214214
/// A builder for reading parquet files from an `async` source as [`ParquetRecordBatchStream`]

0 commit comments

Comments
 (0)