Apply suggestions from code review

Co-authored-by: Zelda Hessler <zhessler@amazon.com>
smithy-lang · Jan 3, 2023 · 5f9829a · 5f9829a
1 parent 694615f
commit 5f9829a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/aws/rust-runtime/aws-config/src/profile/parser.rs b/aws/rust-runtime/aws-config/src/profile/parser.rs
@@ -204,7 +204,7 @@ pub enum ProfileFileLoadError {
     #[non_exhaustive]
     ParseError(ProfileParseError),
 
-    /// The profile file (e.g. `~/.aws/config`) encountered an error reading from the filesystem
+    /// Attempt to read the AWS config file (`~/.aws/config` by default) failed with a filesystem error.
     #[non_exhaustive]
     CouldNotReadFile(CouldNotReadProfileFile),
 }

diff --git a/aws/rust-runtime/aws-config/src/provider_config.rs b/aws/rust-runtime/aws-config/src/provider_config.rs
@@ -42,8 +42,11 @@ pub struct ProviderConfig {
     connector: HttpConnector,
     sleep: Option<Arc<dyn AsyncSleep>>,
     region: Option<Region>,
-    parsed_profile: Arc<OnceCell<Result<ProfileSet, ProfileFileLoadError>>>,
+    // An AWS profile created from `ProfileFiles` and a `profile_name`
+    profile: Arc<OnceCell<Result<ProfileSet, ProfileFileLoadError>>>,
+    // A list of [std::path::Path]s to profile files
     profile_files: ProfileFiles,
+    // An override to use when constructing a `ProfileSet`
     profile_name_override: Option<Cow<'static, str>>,
 }
 
@@ -231,7 +234,7 @@ impl ProviderConfig {
         self
     }
 
-    /// Override profile-file (`~/.aws/config` et al) configuration
+    /// Override the profile file paths (`~/.aws/config` by default) and name (`default` by default)
     pub(crate) fn with_profile_config(
         self,
         profile_files: Option<ProfileFiles>,