[arrow-rs] branch master updated: Remove doc hidden from GenericColumnReader (#2090)

[tu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

tustvold pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git


The following commit(s) were added to refs/heads/master by this push:
     new 13adaa7c5 Remove doc hidden from GenericColumnReader (#2090)
13adaa7c5 is described below

commit 13adaa7c5a6179267124e79a79b1cc7b8976d9a5
Author: Raphael Taylor-Davies <17...@users.noreply.github.com>
AuthorDate: Sat Jul 16 15:24:43 2022 -0400

    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 d2720aede..a7cd38d3c 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<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
index 80174d756..cddd45730 100644
--- 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,