Fix retry config doc comments and remove re-export (#1935)

smithy-lang · Nov 4, 2022 · e2e0d93 · e2e0d93
1 parent 8ba894b
commit e2e0d93
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 4 deletions.
diff --git a/CHANGELOG.next.toml b/CHANGELOG.next.toml
@@ -85,3 +85,10 @@ message = "Ability to add an inline policy or a list of policy ARNs to the `Assu
 references = ["aws-sdk-rust#641", "smithy-rs#1892"]
 meta = { "breaking" = false, "tada" = true, "bug" = false }
 author = "albe-rosado"
+
+[[aws-sdk-rust]]
+message = "Removed re-export of `aws_smithy_client::retry::Config` from the `middleware` module."
+references = ["smithy-rs#1935"]
+meta = { "breaking" = true, "tada" = false, "bug" = false }
+author = "jdisanti"
+
diff --git a/aws/rust-runtime/aws-inlineable/src/middleware.rs b/aws/rust-runtime/aws-inlineable/src/middleware.rs
@@ -5,8 +5,6 @@
 
 //! Base Middleware Stack
 
-pub use aws_smithy_client::retry::Config as RetryConfig;
-
 use aws_endpoint::AwsEndpointStage;
 use aws_http::auth::CredentialsStage;
 use aws_http::recursion_detection::RecursionDetectionStage;

diff --git a/rust-runtime/aws-smithy-client/src/retry.rs b/rust-runtime/aws-smithy-client/src/retry.rs
@@ -44,9 +44,11 @@ where
 
 /// Retry Policy Configuration
 ///
-/// Without specific use cases, users should generally rely on the default values set by `[Config::default]`(Config::default).`
+/// Without specific use cases, users should generally rely on the default values set
+/// by [`Config::default`](Config::default).
 ///
-/// Currently these fields are private and no setters provided. As needed, this configuration will become user-modifiable in the future..
+/// Currently these fields are private and no setters provided. As needed, this configuration
+/// will become user-modifiable in the future.
 #[derive(Clone, Debug)]
 pub struct Config {
     initial_retry_tokens: usize,