Document default value of InstanceCredentialProvider #5188
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tustvold
reviewed
Dec 7, 2023
object_store/src/gcp/builder.rs
Outdated
| @@ -393,7 +393,7 @@ impl GoogleCloudStorageBuilder { | |||
| self | |||
| } | |||
|
|
|||
| /// Set the credential provider overriding any other options | |||
| /// Set the credential provider overriding any other options. Default: [`InstanceCredentialProvider`] | |||
There was a problem hiding this comment.
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?
tustvold
reviewed
Dec 14, 2023
object_store/src/gcp/builder.rs
Outdated
| @@ -393,7 +393,6 @@ impl GoogleCloudStorageBuilder { | |||
| self | |||
| } | |||
|
|
|||
| /// Set the credential provider overriding any other options | |||
object_store/src/gcp/builder.rs
Outdated
| @@ -107,7 +107,7 @@ pub struct GoogleCloudStorageBuilder { | |||
| retry_config: RetryConfig, | |||
| /// Client options | |||
| client_options: ClientOptions, | |||
| /// Credentials | |||
| /// Credentials. Uses instance metadata credentials if not provided | |||
There was a problem hiding this comment.
This won't be rendered on docs.rs as this is a private field, perhaps we could document on the struct, i.e. line 84
|
I took the liberty of getting this over the line |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Closes #5187
Rationale for this change
Couldn't find this info out and wasted an hour or two
What changes are included in this PR?
docs changes
Are there any user-facing changes?
just docs.