[arrow-rs] branch master updated: Feat docs (#4215)

[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 0a8913a37 Feat docs (#4215)
0a8913a37 is described below

commit 0a8913a37dcf2f1c66a00f156f2c3452907e9f9f
Author: Folyd <ly...@gmail.com>
AuthorDate: Mon May 15 00:38:30 2023 +0800

    Feat docs (#4215)
    
    * Feat docs
    
    * Cargo fmt
---
 arrow-ord/src/sort.rs                 | 4 ++--
 parquet/README.md                     | 2 +-
 parquet/src/arrow/async_reader/mod.rs | 4 ++--
 parquet/src/basic.rs                  | 2 +-
 parquet/src/lib.rs                    | 4 ++--
 5 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/arrow-ord/src/sort.rs b/arrow-ord/src/sort.rs
index a44d9a910..144d078d7 100644
--- a/arrow-ord/src/sort.rs
+++ b/arrow-ord/src/sort.rs
@@ -137,8 +137,8 @@ fn partition_validity(array: &dyn Array) -> (Vec<u32>, Vec<u32>) {
 }
 
 /// Sort elements from `ArrayRef` into an unsigned integer (`UInt32Array`) of indices.
-/// For floating point arrays any NaN values are considered to be greater than any other non-null value
-/// limit is an option for partial_sort
+/// For floating point arrays any NaN values are considered to be greater than any other non-null value.
+/// `limit` is an option for [partial_sort].
 pub fn sort_to_indices(
     values: &dyn Array,
     options: Option<SortOptions>,
diff --git a/parquet/README.md b/parquet/README.md
index d904fc64e..d006c47ec 100644
--- a/parquet/README.md
+++ b/parquet/README.md
@@ -65,7 +65,7 @@ The `parquet` crate provides the following features which may be enabled in your
   - [x] Primitive column value writers
   - [ ] Row record writer
   - [x] Arrow record writer
-  - [ ] Async support
+  - [x] Async support
 - [x] Predicate pushdown
 - [x] Parquet format 4.0.0 support
 
diff --git a/parquet/src/arrow/async_reader/mod.rs b/parquet/src/arrow/async_reader/mod.rs
index 248d80d1a..3d4277a83 100644
--- a/parquet/src/arrow/async_reader/mod.rs
+++ b/parquet/src/arrow/async_reader/mod.rs
@@ -482,8 +482,8 @@ impl<T> std::fmt::Debug for StreamState<T> {
     }
 }
 
-/// An asynchronous [`Stream`] of [`RecordBatch`] for a parquet file that can be
-/// constructed using [`ParquetRecordBatchStreamBuilder`]
+/// An asynchronous [`Stream`](https://docs.rs/futures/latest/futures/stream/trait.Stream.html) of [`RecordBatch`]
+/// for a parquet file that can be constructed using [`ParquetRecordBatchStreamBuilder`].
 pub struct ParquetRecordBatchStream<T> {
     metadata: Arc<ParquetMetaData>,
 
diff --git a/parquet/src/basic.rs b/parquet/src/basic.rs
index ec1d4a07a..cc8d033f4 100644
--- a/parquet/src/basic.rs
+++ b/parquet/src/basic.rs
@@ -16,7 +16,7 @@
 // under the License.
 
 //! Contains Rust mappings for Thrift definition.
-//! Refer to `parquet.thrift` file to see raw definitions.
+//! Refer to [`parquet.thrift`](https://github.com/apache/parquet-format/blob/master/src/main/thrift/parquet.thrift) file to see raw definitions.
 
 use std::{fmt, str};
 
diff --git a/parquet/src/lib.rs b/parquet/src/lib.rs
index 4cdba1dc5..2371f8837 100644
--- a/parquet/src/lib.rs
+++ b/parquet/src/lib.rs
@@ -31,8 +31,8 @@
 //! 2. [arrow] for reading and writing parquet files to Arrow
 //! `RecordBatch`es
 //!
-//! 3. [arrow::async_reader] for `async` reading and writing parquet
-//! files to Arrow `RecordBatch`es (requires the `async` feature).
+//! 3. [arrow::async_reader] and [arrow::async_writer] for `async` reading
+//! and writing parquet files to Arrow `RecordBatch`es (requires the `async` feature).
 
 /// Defines a an item with an experimental public API
 ///