Updating docs for app_name on ConfigLoader #3645
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
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
ysaito1001
reviewed
May 15, 2024
There was a problem hiding this comment.
The change looks good! Could you do me a favor and add yourself to tools/ci-build/changelogger/smithy-rs-maintainers.txt as done in this PR?
landonxjames
force-pushed
the
landonxjames/config-app-name-docs
branch
from
ad54a69
to
02179e6
Compare
Bumping version of aws-config crate Updates from PR comments Adding self to maintainers list and changing the target of the CHANGELOG entry.
landonxjames
force-pushed
the
landonxjames/config-app-name-docs
branch
from
02179e6
to
95f9621
Compare
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
Co-authored-by: ysaito1001 <awsaito@amazon.com>
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
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.
Motivation and Context
Docs indicating that the
AppNamecan be loaded from an environment variable or profile key were buried in the default provider and would be hard to find for users.Description
This change adds documentation to the
app_namemethod onConfigLoaderthat makes the options for loading theAppNamemore explicit.Testing
Ran
cargo docto ensure the docs were generated correctlyChecklist
CHANGELOG.next.tomlif I made changes to the smithy-rs codegen or runtime cratesBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.