Review feedback

apache · Jan 31, 2022 · 38e2225 · 38e2225
1 parent 92b7cb9
commit 38e2225
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -111,7 +111,7 @@ jobs:
           cargo test
           cd arrow
           # re-run tests on arrow workspace with additional features
-          cargo test --features=prettyprint
+          cargo test --features=prettyprint --features=async
           # run test on arrow with minimal set of features
           cargo test --no-default-features
           cargo run --example builders
@@ -238,7 +238,7 @@ jobs:
         run: |
           export CARGO_HOME="/github/home/.cargo"
           export CARGO_TARGET_DIR="/github/home/target"
-          cargo clippy --features test_common --all-targets --workspace -- -D warnings -A clippy::redundant_field_names
+          cargo clippy --features test_common --features prettyprint  --features=async --all-targets --workspace -- -D warnings -A clippy::redundant_field_names
 
   check_benches:
     name: Check Benchmarks (but don't run them)

diff --git a/parquet/Cargo.toml b/parquet/Cargo.toml
@@ -65,7 +65,7 @@ cli = ["serde_json", "base64", "clap"]
 test_common = []
 # Experimental, unstable functionality primarily used for testing
 experimental = []
-# Experimental, unstable, async API
+# Enable async API
 async = ["futures", "tokio"]
 
 [[bin]]

diff --git a/parquet/src/arrow/async_reader.rs b/parquet/src/arrow/async_reader.rs
@@ -163,6 +163,7 @@ impl<T: AsyncRead + AsyncSeek + Unpin> ParquetRecordBatchStreamBuilder<T> {
 }
 
 enum StreamState<T> {
+    /// At the start of a new row group, or the end of the parquet stream
     Init,
     /// Decoding a batch
     Decoding(ParquetRecordBatchReader),
@@ -183,7 +184,7 @@ impl<T> std::fmt::Debug for StreamState<T> {
     }
 }
 
-/// A [`Stream`] of [`RecordBatch`] for a parquet file
+/// An asynchronous [`Stream`] of [`RecordBatch`] for a parquet file
 pub struct ParquetRecordBatchStream<T> {
     metadata: Arc<ParquetMetaData>,