Lots of doc tweaks and cleanups (#693) (0b32a897) · Commits · Public Repositories / Smithy Rust

aws/rust-runtime/aws-config/src/default_provider.rs

+5 −1

Original line number	Diff line number	Diff line
		@@ -3,7 +3,11 @@
		* SPDX-License-Identifier: Apache-2.0.
		*/

		//! Default Provider chains for [`region`](default_provider::region) and credentials (TODO)
		//! Default Provider chains for [`region`](default_provider::region) and [`credentials`](default_provider::credentials).
		//!
		//! Unless specific configuration is required, these should be constructed via [`ConfigLoader`](crate::ConfigLoader).
		//!
		//!

		/// Default region provider chain
		pub mod region {

aws/rust-runtime/aws-config/src/lib.rs

+8 −6

Original line number	Diff line number	Diff line
		#![deny(missing_docs)]

		//! `aws-config` provides implementations of region, credential (todo), and connector (todo) resolution.
		//! `aws-config` provides implementations of region, credential resolution.
		//!
		//! These implementations can be used either via the default chain implementation
		//! [`from_env`]/[`ConfigLoader`] or ad-hoc individual credential and region providers.
		//!
		//! These implementations can be used either adhoc or via [`from_env`](from_env)/[`ConfigLoader`](ConfigLoader).
		//! [`ConfigLoader`](ConfigLoader) can combine different configuration sources into an AWS shared-config:
		//! [`Config`](aws_types::config::Config). [`Config`](aws_types::config::Config) can be used configure
		//! an AWS service client.
		//!
		//! ## Examples
		//! # Examples
		//! Load default SDK configuration:
		//! ```rust
		//! # mod aws_sdk_dynamodb {
		@@ -66,7 +68,7 @@ pub mod provider_config;

		/// Create an environment loader for AWS Configuration
		///
		/// ## Example
		/// # Examples
		/// ```rust
		/// # async fn create_config() {
		/// use aws_types::region::Region;
		@@ -112,7 +114,7 @@ mod loader {
		impl ConfigLoader {
		/// Override the region used to build [`Config`](aws_types::config::Config).
		///
		/// # Example
		/// # Examples
		/// ```rust
		/// # async fn create_config() {
		/// use aws_types::region::Region;
		@@ -127,7 +129,7 @@ mod loader {
		}

		/// Override the credentials provider used to build [`Config`](aws_types::config::Config).
		/// # Example
		/// # Examples
		/// Override the credentials provider but load the default value for region:
		/// ```rust
		/// # use aws_types::Credentials;

aws/rust-runtime/aws-config/src/meta/credentials/chain.rs

+1 −1

Original line number	Diff line number	Diff line
		@@ -18,7 +18,7 @@ use tracing::Instrument;
		/// the next provider will be checked.
		/// * Finally, if a provider returns any other error condition, an error will be returned immediately.
		///
		/// ## Example
		/// # Examples
		/// ```rust
		/// use aws_config::meta::credentials::CredentialsProviderChain;
		/// use aws_types::Credentials;

aws/rust-runtime/aws-config/src/meta/credentials/credential_fn.rs

+1 −1

Original line number	Diff line number	Diff line
		@@ -36,7 +36,7 @@ where
		/// to create an [`ProvideCredentials`] implementation from an async block that returns
		/// a [`credentials::Result`].
		///
		/// # Example
		/// # Examples
		///
		/// ```
		/// use aws_types::Credentials;

aws/rust-runtime/aws-config/src/meta/credentials/lazy_caching.rs

+1 −1

Original line number	Diff line number	Diff line
		@@ -125,7 +125,7 @@ mod builder {

		/// Builder for constructing a [`LazyCachingCredentialsProvider`].
		///
		/// # Example
		/// # Examples
		///
		/// ```
		/// use aws_types::Credentials;