chore: Miscellaneous comment fixes / updates #1752
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
jbelkins
approved these changes
Sep 17, 2024
| @@ -11,7 +11,7 @@ import SmithyIdentityAPI | |||
| public protocol AWSDefaultClientConfiguration { | |||
| /// The AWS credential identity resolver to be used for AWS credentials. | |||
| /// | |||
| /// If no resolver is supplied, the SDK will look for credentials in the environment, then in the `~/.aws/credentials` file. | |||
| /// If no resolver is supplied, `AWSSDKIdentity.DefaultAWSCredentialIdentityResolverChain` gets used by default. | |||
There was a problem hiding this comment.
Should we document the specific order of resolvers in this chain?
There was a problem hiding this comment.
I figured that for customers that really want to know, they can locate that component and look at doc comments on that given there's the module name and component name. Thought we would rather avoid duplicating doc comments.
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.
Issue #
Description of changes
New/existing dependencies impact assessment, if applicable
Conventional Commits
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.