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 examples section to datafusion crate doc #457

Merged
merged 1 commit into from
Jun 1, 2021

Conversation

mluts
Copy link
Contributor

@mluts mluts commented May 31, 2021

Which issue does this PR close?

Closes #186 .

Rationale for this change

Making it easier for newcomers to run example code.
Unfortunately i didn't find any option how to make versioned links, but i hope this still will be helpful 🙂

What changes are included in this PR?

Added "Examples" section to datafusion crate doc

Are there any user-facing changes?

Yes, but only crate docs

Copy link
Contributor

@alamb alamb left a comment

Choose a reason for hiding this comment

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

Thank you @mluts !

//! cd arrow-datafusion
//! # Download test data
//! git submodule update --init
//! export PARQUET_TEST_DATA=parquet-testing/data
Copy link
Contributor

Choose a reason for hiding this comment

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

This stuff is unfortunate - it would be nice to have the examples be able to find this on their own (as we have done with arrow-rs).

I have filed a ticket here: #467

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@alamb Great idea 👍
I'll try to work on #467 then

Thank you 🙂

@alamb
Copy link
Contributor

alamb commented Jun 1, 2021

Thanks again @mluts !

@alamb alamb merged commit 13c907c into apache:master Jun 1, 2021
@houqp houqp added datafusion Changes in the datafusion crate documentation Improvements or additions to documentation labels Jul 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
datafusion Changes in the datafusion crate documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

No way to get to the examples from docs.rs
3 participants