diff --git a/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/SystemResources.cs b/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/SystemResources.cs index 7fda19cd9dd..36b240c7a4f 100644 --- a/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/SystemResources.cs +++ b/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/SystemResources.cs @@ -3,7 +3,7 @@ namespace Microsoft.Extensions.Diagnostics.ResourceMonitoring; /// -/// CPU and memory limits defined by the underlying system. +/// Provides information about the CPU and memory limits defined by the underlying system. /// #pragma warning disable CA1815 // Override equals and operator equals on value types public readonly struct SystemResources @@ -13,12 +13,12 @@ public readonly struct SystemResources /// Gets the CPU units available in the system. /// /// - /// This value corresponds to the number of the guaranteed CPUs as described by Kubernetes CPU request parameter, each 1000 CPU units - /// represent 1 CPU or 1 Core. For example, if the POD is configured with 1500m units as the CPU request, this property will be assigned - /// to 1.5 which means one and a half CPU will be dedicated for the POD. - /// For POD this value is calculated based on the cgroupv2 weight, using the formula. - /// y = (1 + ((x - 2) * 9999) / 262142), where y is the CPU weight and x is the CPU share (cgroup v1). - /// https://github.com/kubernetes/enhancements/tree/master/keps/sig-node/2254-cgroup-v2#phase-1-convert-from-cgroups-v1-settings-to-v2. + /// This value corresponds to the number of the guaranteed CPUs as described by Kubernetes CPU request parameter. Each 1000 CPU units + /// represent 1 CPU or 1 Core. For example, if the Pod is configured with 1500m units as the CPU request, this property will be assigned + /// to 1.5, which means one and a half CPU will be dedicated for the Pod. + /// For a Pod, this value is calculated based on the cgroupv2 weight, using the formula + /// y = (1 + ((x - 2) * 9999) / 262142), where y is the CPU weight and x is the CPU share (cgroup v1). + /// For more information, see . /// public double GuaranteedCpuUnits { get; } @@ -26,9 +26,9 @@ public readonly struct SystemResources /// Gets the maximum CPU units available in the system. /// /// - /// This value corresponds to the number of the maximum CPUs as described by Kubernetes CPU limit parameter, each 1000 CPU units - /// represent 1 CPU or 1 Core. For example, if the is configured with 1500m units as the CPU limit, this property will be assigned - /// to 1.5 which means one and a half CPU will be the maximum CPU available. + /// This value corresponds to the number of the maximum CPUs as described by Kubernetes CPU limit parameter. Each 1000 CPU units + /// represent 1 CPU or 1 Core. For example, if the Pod is configured with 1500m units as the CPU limit, this property will be assigned + /// to 1.5, which means one and a half CPU will be the maximum CPU available. /// public double MaximumCpuUnits { get; } @@ -38,7 +38,7 @@ public readonly struct SystemResources public ulong GuaranteedMemoryInBytes { get; } /// - /// Gets the Container's Request Memory Limit or the Maximum allocated for the VM. + /// Gets the container's request memory limit or the maximum allocated for the VM. /// public ulong MaximumMemoryInBytes { get; } diff --git a/src/Libraries/Microsoft.Extensions.Http.Resilience/Hedging/HttpHedgingStrategyOptions.cs b/src/Libraries/Microsoft.Extensions.Http.Resilience/Hedging/HttpHedgingStrategyOptions.cs index 07272cc9916..6d9735231b4 100644 --- a/src/Libraries/Microsoft.Extensions.Http.Resilience/Hedging/HttpHedgingStrategyOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Http.Resilience/Hedging/HttpHedgingStrategyOptions.cs @@ -8,7 +8,7 @@ namespace Microsoft.Extensions.Http.Resilience; /// -/// Implementation of the for results. +/// Implementation of the class for results. /// public class HttpHedgingStrategyOptions : HedgingStrategyOptions { @@ -16,8 +16,8 @@ public class HttpHedgingStrategyOptions : HedgingStrategyOptions class. /// /// - /// By default, the options is set to handle only transient failures, - /// i.e. timeouts, 5xx responses and exceptions. + /// By default, the options are set to handle only transient failures, + /// that is, timeouts, 5xx responses, and exceptions. /// public HttpHedgingStrategyOptions() { diff --git a/src/Libraries/Microsoft.Extensions.Options.Contextual/IContextualOptions.cs b/src/Libraries/Microsoft.Extensions.Options.Contextual/IContextualOptions.cs index 66d9bb750a9..7aaed9589ad 100644 --- a/src/Libraries/Microsoft.Extensions.Options.Contextual/IContextualOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Options.Contextual/IContextualOptions.cs @@ -7,10 +7,10 @@ namespace Microsoft.Extensions.Options.Contextual; /// -/// Used to retrieve configured instances. +/// Provides functionality to retrieve configured instances. /// /// The type of options being requested. -/// A type defining the context for this request. +/// A type that defines the context for this request. public interface IContextualOptions where TOptions : class where TContext : IOptionsContext diff --git a/src/Libraries/Microsoft.Extensions.Options.Contextual/INamedContextualOptions.cs b/src/Libraries/Microsoft.Extensions.Options.Contextual/INamedContextualOptions.cs index 72f0a427859..609b192cb6a 100644 --- a/src/Libraries/Microsoft.Extensions.Options.Contextual/INamedContextualOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Options.Contextual/INamedContextualOptions.cs @@ -7,7 +7,7 @@ namespace Microsoft.Extensions.Options.Contextual; /// -/// Used to retrieve named configured instances. +/// Provides functionality to retrieve named configured instances. /// /// The type of options being requested. /// A type defining the context for this request. diff --git a/src/Libraries/Microsoft.Extensions.Options.Contextual/Provider/IConfigureContextualOptions.cs b/src/Libraries/Microsoft.Extensions.Options.Contextual/Provider/IConfigureContextualOptions.cs index 1e8f0c367d5..9d838cf49dd 100644 --- a/src/Libraries/Microsoft.Extensions.Options.Contextual/Provider/IConfigureContextualOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Options.Contextual/Provider/IConfigureContextualOptions.cs @@ -6,14 +6,14 @@ namespace Microsoft.Extensions.Options.Contextual.Provider; /// -/// Represents something that configures the type. +/// Provides functionality to configure the type. /// /// The type of options configured. public interface IConfigureContextualOptions : IDisposable where TOptions : class { /// - /// Invoked to configure a instance. + /// Configures a instance. /// /// The options instance to configure. void Configure(TOptions options); diff --git a/src/Libraries/Microsoft.Extensions.Options.Contextual/Provider/ILoadContextualOptions.cs b/src/Libraries/Microsoft.Extensions.Options.Contextual/Provider/ILoadContextualOptions.cs index 391b1645157..72eeb7da482 100644 --- a/src/Libraries/Microsoft.Extensions.Options.Contextual/Provider/ILoadContextualOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Options.Contextual/Provider/ILoadContextualOptions.cs @@ -7,7 +7,7 @@ namespace Microsoft.Extensions.Options.Contextual.Provider; /// -/// Used to retrieve named configuration data from a contextual options provider implementation. +/// Provides functionality to retrieve named configuration data from a contextual options provider implementation. /// /// The type of options configured. public interface ILoadContextualOptions diff --git a/src/Libraries/Microsoft.Extensions.Options.Contextual/Provider/IOptionsContextReceiver.cs b/src/Libraries/Microsoft.Extensions.Options.Contextual/Provider/IOptionsContextReceiver.cs index a9a78471270..86ba043b449 100644 --- a/src/Libraries/Microsoft.Extensions.Options.Contextual/Provider/IOptionsContextReceiver.cs +++ b/src/Libraries/Microsoft.Extensions.Options.Contextual/Provider/IOptionsContextReceiver.cs @@ -4,12 +4,12 @@ namespace Microsoft.Extensions.Options.Contextual.Provider; /// -/// Used by contextual options providers to collect context data. +/// Provides functionality for contextual options providers to collect context data. /// public interface IOptionsContextReceiver { /// - /// Add a key-value pair to the context. + /// Adds a key-value pair to the context. /// /// The type of the data. /// The name of the data. diff --git a/src/Libraries/Microsoft.Extensions.Options.Contextual/Provider/NullConfigureContextualOptions.cs b/src/Libraries/Microsoft.Extensions.Options.Contextual/Provider/NullConfigureContextualOptions.cs index 324bbaf1702..3721b4eba7a 100644 --- a/src/Libraries/Microsoft.Extensions.Options.Contextual/Provider/NullConfigureContextualOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Options.Contextual/Provider/NullConfigureContextualOptions.cs @@ -4,7 +4,7 @@ namespace Microsoft.Extensions.Options.Contextual.Provider; /// -/// Helper class. +/// Provides helper methods for a configuration context. This class can't be inherited. /// public static class NullConfigureContextualOptions { diff --git a/src/Libraries/Microsoft.Extensions.Options.Contextual/Provider/NullConfigureContextualOptions_1.cs b/src/Libraries/Microsoft.Extensions.Options.Contextual/Provider/NullConfigureContextualOptions_1.cs index 8ec2922e110..37533a1d7c7 100644 --- a/src/Libraries/Microsoft.Extensions.Options.Contextual/Provider/NullConfigureContextualOptions_1.cs +++ b/src/Libraries/Microsoft.Extensions.Options.Contextual/Provider/NullConfigureContextualOptions_1.cs @@ -6,7 +6,7 @@ namespace Microsoft.Extensions.Options.Contextual.Provider; #pragma warning disable SA1649 // File name should match first type name /// -/// A do-nothing implementation of . +/// Implements but does nothing. /// /// The options type to configure. internal sealed class NullConfigureContextualOptions : IConfigureContextualOptions