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

Update documentation example for change in API #1812

Merged
merged 3 commits into from
Feb 16, 2022

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Feb 12, 2022

Which issue does this PR close?

re #1587

I noticed the examples don't work anymore when testing out the latest datafusion release. 🤦

Rationale for this change

The example (published at https://arrow.apache.org/datafusion/user-guide/example-usage.html) is the first thing users will likely try

What changes are included in this PR?

Update the example so it will run with changes to make more methods async

Are there any user-facing changes?

Just docs

docs/source/user-guide/example-usage.md Outdated Show resolved Hide resolved
@@ -28,18 +37,18 @@ use datafusion::prelude::*;
async fn main() -> datafusion::error::Result<()> {
// register the table
let mut ctx = ExecutionContext::new();
ctx.register_csv("example", "tests/example.csv", CsvReadOptions::new())?;
ctx.register_csv("example", "tests/example.csv", CsvReadOptions::new()).await?;
Copy link
Member

Choose a reason for hiding this comment

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

Amazing! unexpectedly, no .await before.

@alamb alamb merged commit 2a5a431 into apache:master Feb 16, 2022
@alamb
Copy link
Contributor Author

alamb commented Feb 16, 2022

Thanks for the review @xudong963

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants