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

Add user guide to Rust docs #831

Open
wjones127 opened this issue Sep 21, 2022 · 5 comments
Open

Add user guide to Rust docs #831

wjones127 opened this issue Sep 21, 2022 · 5 comments
Labels
binding/rust Issues for the Rust crate documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@wjones127
Copy link
Collaborator

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 wjones127 added enhancement New feature or request documentation Improvements or additions to documentation good first issue Good for newcomers binding/rust Issues for the Rust crate labels Sep 21, 2022
@wjones127
Copy link
Collaborator Author

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
Copy link
Collaborator

roeap commented Nov 18, 2022

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

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

@tbar4
Copy link

tbar4 commented Aug 15, 2024

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
Copy link
Collaborator

@tbar4 for sure!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
binding/rust Issues for the Rust crate documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

5 participants