You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by al...@apache.org on 2022/05/12 14:49:18 UTC

[arrow-rs] branch master updated: Add `async` into doc features (#1349)

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

alamb 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 101edc91f Add `async` into doc features (#1349)
101edc91f is described below

commit 101edc91f8d329464a8267eb6378a4a2521d3ca8
Author: Remzi Yang <59...@users.noreply.github.com>
AuthorDate: Thu May 12 22:49:14 2022 +0800

    Add `async` into doc features (#1349)
    
    * add async to default features
    
    Signed-off-by: remzi <13...@gmail.com>
    
    * remove async from default features
    
    Signed-off-by: remzi <13...@gmail.com>
    
    * add doc metadata
    
    Signed-off-by: remzi <13...@gmail.com>
    
    Co-authored-by: Andrew Lamb <an...@nerdnetworks.org>
---
 parquet/Cargo.toml       | 4 ++++
 parquet/src/arrow/mod.rs | 1 +
 2 files changed, 5 insertions(+)

diff --git a/parquet/Cargo.toml b/parquet/Cargo.toml
index 5007829c7..080c1b689 100644
--- a/parquet/Cargo.toml
+++ b/parquet/Cargo.toml
@@ -61,6 +61,10 @@ lz4 = "1.23"
 serde_json = { version = "1.0", features = ["preserve_order"] }
 arrow = { path = "../arrow", version = "13.0.0", default-features = false, features = ["test_utils", "prettyprint"] }
 
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "doc_cfg"]
+
 [features]
 default = ["arrow", "snap", "brotli", "flate2", "lz4", "zstd", "base64"]
 cli = ["serde_json", "base64", "clap"]
diff --git a/parquet/src/arrow/mod.rs b/parquet/src/arrow/mod.rs
index ea4760c03..833c1c1cb 100644
--- a/parquet/src/arrow/mod.rs
+++ b/parquet/src/arrow/mod.rs
@@ -121,6 +121,7 @@ pub mod arrow_writer;
 mod bit_util;
 
 #[cfg(feature = "async")]
+#[cfg_attr(doc_cfg, doc(cfg(feature = "async")))]
 pub mod async_reader;
 
 experimental_mod!(converter);