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.

Sign up for GitHub

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

Document default value of InstanceCredentialProvider #5188

Merged
merged 4 commits into from
Dec 23, 2023
Merged

Document default value of InstanceCredentialProvider #5188

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b67d719
Document default value of InstanceCredentialProvider
justinabrahms Dec 7, 2023
a6b0371
Move docs to credentials field rather than crate-private method
justinabrahms Dec 13, 2023
e614096
Review feedback
tustvold Dec 23, 2023
8c1ee2f
Tweak doctest
tustvold Dec 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion object_store/src/gcp/builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@ impl GoogleCloudStorageBuilder {
self
}

/// Set the credential provider overriding any other options
Copy link
Contributor

Choose a reason for hiding this comment

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

Why this removal?

/// Set the credential provider overriding any other options. Default: [`InstanceCredentialProvider`]
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a crate-private struct, hence why the docs aren't building cleanly.

Perhaps we could instead add a comment on the builder itself that if no credentials are configured, it will default to using instance metadata credentials?

pub fn with_credentials(mut self, credentials: GcpCredentialProvider) -> Self {
self.credentials = Some(credentials);
self
Expand Down
Loading