Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refresh parquet readme / contributing guide #1252

Merged
merged 1 commit into from
Feb 2, 2022

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Feb 1, 2022

This PR cleans up the repo readme and contributing guide

I am working on a PR to improve the docs.rs page next https://docs.rs/parquet/8.0.0/parquet/

@github-actions github-actions bot added the parquet Changes to the parquet crate label Feb 1, 2022
use std::fs::File;
use std::path::Path;
use parquet::file::reader::{FileReader, SerializedFileReader};

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)


## 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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@@ -63,11 +37,13 @@ version is available. Then simply update version of `parquet-format` crate in Ca
- [x] Primitive column value readers
- [x] Row record reader
- [x] Arrow record reader
- [x] Async support (to Arrow)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

assumes #1154 is merged

@alamb alamb added the documentation Improvements or additions to documentation label Feb 1, 2022
@alamb alamb requested a review from jimexist February 1, 2022 14:47
@alamb
Copy link
Contributor Author

alamb commented Feb 2, 2022

Parquet doc updates: #1253

@alamb alamb merged commit f80f1be into apache:master Feb 2, 2022
@alamb alamb deleted the alamb/parquet_doc branch February 2, 2022 11:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation parquet Changes to the parquet crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants