You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2022/02/01 13:53:00 UTC

[GitHub] [arrow-rs] alamb opened a new pull request #1253: Update parquet crate documentation and examples

alamb opened a new pull request #1253:
URL: https://github.com/apache/arrow-rs/pull/1253


   # Which issue does this PR close?
   Re https://github.com/apache/arrow-rs/issues/111
   
   # Rationale for changes 
   
   The docs.rs page is pretty sparse https://docs.rs/parquet/8.0.0/parquet/
   ![Screen Shot 2022-02-01 at 8 51 37 AM](https://user-images.githubusercontent.com/490673/151980725-578169b1-35ea-4cd4-9b43-4c900b2eda20.png)
   
   
   # What changes are included in this PR?
   
   1. Moved async parquet test to doc example
   
   Some better docs as well as doc examples:
   ![Screen Shot 2022-02-01 at 8 52 03 AM](https://user-images.githubusercontent.com/490673/151980840-db66fe92-281b-4190-bb19-9451ab78f334.png)
   
   ![Screen Shot 2022-02-01 at 8 52 19 AM](https://user-images.githubusercontent.com/490673/151980883-12caa55b-d3e2-4676-b57a-2ba415ff3dfa.png)
   
   2. fixup various doc warnings
   
   # Are there any user-facing changes?
   
   Docs


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow-rs] tustvold commented on a change in pull request #1253: Update parquet crate documentation and examples

Posted by GitBox <gi...@apache.org>.
tustvold commented on a change in pull request #1253:
URL: https://github.com/apache/arrow-rs/pull/1253#discussion_r796692713



##########
File path: parquet/src/arrow/async_reader.rs
##########
@@ -15,8 +15,64 @@
 // specific language governing permissions and limitations
 // under the License.
 
-//! Contains asynchronous APIs for reading parquet files into
-//! arrow [`RecordBatch`]
+//! Provides `async` API for reading parquet files as
+//! [`RecordBatch`]es
+//!
+//! ```
+//! # #[tokio::main(flavor="current_thread")]
+//! # async fn main() {
+//! #
+//! use arrow::record_batch::RecordBatch;
+//! use arrow::util::pretty::pretty_format_batches;
+//! use futures::TryStreamExt;
+//! use tokio::fs::File;
+//!
+//! use parquet::arrow::ParquetRecordBatchStreamBuilder;
+//!
+//! # fn assert_batches_eq(batches: &[RecordBatch], expected_lines: &[&str]) {

Review comment:
       TIL that you can hide doc code using `#` :+1:




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow-rs] alamb commented on pull request #1253: Update parquet crate documentation and examples

Posted by GitBox <gi...@apache.org>.
alamb commented on pull request #1253:
URL: https://github.com/apache/arrow-rs/pull/1253#issuecomment-1038107816


   Sadly, the link to the async reader doc doesn't seem to work on docs.rs: https://github.com/apache/arrow-rs/issues/1307


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow-rs] alamb merged pull request #1253: Update parquet crate documentation and examples

Posted by GitBox <gi...@apache.org>.
alamb merged pull request #1253:
URL: https://github.com/apache/arrow-rs/pull/1253


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow-rs] alamb commented on pull request #1253: Update parquet crate documentation and examples

Posted by GitBox <gi...@apache.org>.
alamb commented on pull request #1253:
URL: https://github.com/apache/arrow-rs/pull/1253#issuecomment-1038107816


   Sadly, the link to the async reader doc doesn't seem to work on docs.rs: https://github.com/apache/arrow-rs/issues/1307


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org