[GitHub] [arrow-rs] alamb commented on a change in pull request #1252: Refresh parquet readme / contributing guide

[GitBox <gi...@apache.org>]

alamb commented on a change in pull request #1252:
URL: https://github.com/apache/arrow-rs/pull/1252#discussion_r796502282



##########
File path: parquet/README.md
##########
@@ -23,38 +23,12 @@
 
 This crate contains the official Native Rust implementation of [Apache Parquet](https://parquet.apache.org/), which is part of the [Apache Arrow](https://arrow.apache.org/) project.
 
-## Example
-
-Example usage of reading data:
-
-```rust
-use std::fs::File;
-use std::path::Path;
-use parquet::file::reader::{FileReader, SerializedFileReader};
-

Review comment:
       This example is row oriented -- I am working on a PR that has some more realistic examples (and will include them on the docs.rs landing page)

##########
File path: parquet/README.md
##########
@@ -23,38 +23,12 @@
 
 This crate contains the official Native Rust implementation of [Apache Parquet](https://parquet.apache.org/), which is part of the [Apache Arrow](https://arrow.apache.org/) project.
 
-## Example
-
-Example usage of reading data:
-
-```rust
-use std::fs::File;
-use std::path::Path;
-use parquet::file::reader::{FileReader, SerializedFileReader};
-
-let file = File::open(&Path::new("/path/to/file")).unwrap();
-let reader = SerializedFileReader::new(file).unwrap();
-let mut iter = reader.get_row_iter(None).unwrap();
-while let Some(record) = iter.next() {
-    println!("{}", record);
-}
-```
-
-For an example of reading to Arrow arrays, please see [here](https://docs.rs/parquet/latest/parquet/arrow/index.html)
-
-See [crate documentation](https://docs.rs/parquet/latest/parquet/) for the full API.
+See [crate documentation](https://docs.rs/parquet/latest/parquet/) for examples and the full API.
 
 ## Rust Version Compatbility
 
 This crate is tested with the latest stable version of Rust. We do not currrently test against other, older versions of the Rust compiler.
 
-## Supported Parquet Version

Review comment:
       the supported format is already listed in the features section -- moved this content to contributing guide




-- 
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