From 049287db3c9b12510f42e7dd16cd08f69ab91b9d Mon Sep 17 00:00:00 2001 From: ysaito1001 Date: Tue, 28 Feb 2023 14:35:08 -0600 Subject: [PATCH] Fix Inaccurate documentation on ProfileFileCredentialsProvider (#2421) This commit addresses https://github.com/awslabs/aws-sdk-rust/issues/746. Co-authored-by: Yuki Saito --- aws/rust-runtime/aws-config/src/profile/credentials.rs | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/aws/rust-runtime/aws-config/src/profile/credentials.rs b/aws/rust-runtime/aws-config/src/profile/credentials.rs index ba7fb9241e..9ce085503b 100644 --- a/aws/rust-runtime/aws-config/src/profile/credentials.rs +++ b/aws/rust-runtime/aws-config/src/profile/credentials.rs @@ -61,9 +61,8 @@ impl ProvideCredentials for ProfileFileCredentialsProvider { /// let provider = ProfileFileCredentialsProvider::builder().build(); /// ``` /// -/// _Note: Profile providers to not implement any caching. They will reload and reparse the profile -/// from the file system when called. See [CredentialsCache](aws_credential_types::cache::CredentialsCache) for -/// more information about caching._ +/// _Note: Profile providers, when called, will load and parse the profile from the file system +/// only once. Parsed file contents will be cached indefinitely._ /// /// This provider supports several different credentials formats: /// ### Credentials defined explicitly within the file