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

Docs: add examples for RuntimeEnv::register_object_store, improve error messages #10617

Merged
merged 3 commits into from
May 22, 2024

Conversation

aditanase
Copy link
Contributor

Which issue does this PR close?

Closes #10616. Documentation only

@alamb
Copy link
Contributor

alamb commented May 22, 2024

Thank you @aditanase -- this is great 🙏 . I started the CI

Also I made another PR to try and improve the documentation about ObjectStoreUrl in general as I found that confusing

@alamb alamb changed the title Docs: add examples for RuntimeEnv::register_object_store Docs: add examples for RuntimeEnv::register_object_store, improve error messages May 22, 2024
///
/// Or how to set up a http object store:
/// ```
/// let base_url = Url::parse("https://github.com").unwrap();
Copy link
Contributor

Choose a reason for hiding this comment

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

These examples are run automatically via cargo test --doc -- so they need to be completely standlone

I took the liberty of pushing a commit to this PR that did so

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks so much for making these pass, I'll remember to run the doc tests next time, only looked at the doc site before submitting the PR.

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.

Thanks again @aditanase -- really apprecaited

@alamb alamb merged commit 513d8d1 into apache:main May 22, 2024
23 checks passed
findepi pushed a commit to findepi/datafusion that referenced this pull request Jul 16, 2024
…rror messages (apache#10617)

* Docs: add examples for RuntimeEnv::register_object_store

* adjust example

---------

Co-authored-by: Andrew Lamb <[email protected]>
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.

Make it easier to register object stores
2 participants