delta-io / delta-rs

A native Rust library for Delta Lake, with bindings into Python
https://delta-io.github.io/delta-rs/
Apache License 2.0
2.29k stars 404 forks source link

Add user guide to Rust docs #831

Open wjones127 opened 2 years ago

wjones127 commented 2 years ago

Description

Python now has a decent user guide: https://delta-io.github.io/delta-rs/python/usage.html

We should write the equivalent of that for Rust on our crate homepage: https://docs.rs/deltalake/latest/deltalake/

Use Case

Related Issue(s)

wjones127 commented 1 year ago

We should make sure we have good docs for the operations module in particular: https://github.com/delta-io/delta-rs/blob/main/rust/src/operations/mod.rs

roeap commented 1 year ago

I am currently working on writing an example / docs and tuning the api a bit for the create command.

Of course other commands need to follow 🙂

zachschuermann commented 1 year ago

chatted some with @wjones127 this morning and volunteered to help out here :)

tbar4 commented 2 months ago

Is this issue still available to work on? I know it’s still open, but nearly two years old at this point so I want to make sure before I spend time contributing.

ion-elgreco commented 2 months ago

@tbar4 for sure!!