From 13adaa7c5a6179267124e79a79b1cc7b8976d9a5 Mon Sep 17 00:00:00 2001 From: Raphael Taylor-Davies <1781103+tustvold@users.noreply.github.com> Date: Sat, 16 Jul 2022 15:24:43 -0400 Subject: [PATCH] Remove doc hidden from GenericColumnReader (#2090) * Remove doc hidden * Fix private doc links --- parquet/src/arrow/record_reader/mod.rs | 1 - parquet/src/column/reader.rs | 7 +++---- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/parquet/src/arrow/record_reader/mod.rs b/parquet/src/arrow/record_reader/mod.rs index d2720aedeb8..a7cd38d3c17 100644 --- a/parquet/src/arrow/record_reader/mod.rs +++ b/parquet/src/arrow/record_reader/mod.rs @@ -45,7 +45,6 @@ pub(crate) const MIN_BATCH_SIZE: usize = 1024; pub type RecordReader = GenericRecordReader::T>, ColumnValueDecoderImpl>; -#[doc(hidden)] /// A generic stateful column reader that delimits semantic records /// /// This type is hidden from the docs, and relies on private traits with no diff --git a/parquet/src/column/reader.rs b/parquet/src/column/reader.rs index 80174d75679..cddd45730dd 100644 --- a/parquet/src/column/reader.rs +++ b/parquet/src/column/reader.rs @@ -108,12 +108,11 @@ pub type ColumnReaderImpl = GenericColumnReader< decoder::ColumnValueDecoderImpl, >; -#[doc(hidden)] /// Reads data for a given column chunk, using the provided decoders: /// -/// - R: [`ColumnLevelDecoder`] used to decode repetition levels -/// - D: [`ColumnLevelDecoder`] used to decode definition levels -/// - V: [`ColumnValueDecoder`] used to decode value data +/// - R: `ColumnLevelDecoder` used to decode repetition levels +/// - D: `ColumnLevelDecoder` used to decode definition levels +/// - V: `ColumnValueDecoder` used to decode value data pub struct GenericColumnReader { descr: ColumnDescPtr,