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

Improve docs for AmazonS3Builder::from_env #6977

Merged
merged 3 commits into from
Jan 15, 2025

Conversation

kylebarron
Copy link
Contributor

Which issue does this PR close?

Closes #.

Rationale for this change

The documentation for AmazonS3Builder::from_env makes it seem like only specific AWS environment variables are looked for in the current environment. However any env vars starting with AWS_ are checked.

What changes are included in this PR?

Document that all env vars starting with AWS_ are checked, so any value in AmazonS3ConfigKey can be used.

Are there any user-facing changes?

No, documentation only.

@github-actions github-actions bot added the object-store Object Store Interface label Jan 13, 2025
@kylebarron
Copy link
Contributor Author

Perhaps the Azure and GCS from_env docs should be updated similarly? I haven't looked at their implementations.

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 @kylebarron !

@tustvold tustvold merged commit 12a1235 into apache:main Jan 15, 2025
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
object-store Object Store Interface
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants