Remove doc hidden from GenericColumnReader (#2090)

* Remove doc hidden * Fix private doc links
apache · Jul 16, 2022 · 13adaa7 · 13adaa7
1 parent 1738a90
commit 13adaa7
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 5 deletions.
diff --git 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<T> =
     GenericRecordReader<ScalarBuffer<<T as DataType>::T>, ColumnValueDecoderImpl<T>>;
 
-#[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
@@ -108,12 +108,11 @@ pub type ColumnReaderImpl<T> = GenericColumnReader<
     decoder::ColumnValueDecoderImpl<T>,
 >;
 
-#[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<R, D, V> {
     descr: ColumnDescPtr,