From eb321bd00d6a8dd4cbff56d3e95e58295b0a96b9 Mon Sep 17 00:00:00 2001
From: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
Date: Wed, 9 Oct 2024 09:49:04 -0700
Subject: [PATCH 1/2] doc updates
---
.../HybridCacheOptions.cs | 38 +++++++++++++------
1 file changed, 27 insertions(+), 11 deletions(-)
diff --git a/src/Libraries/Microsoft.Extensions.Caching.Hybrid/HybridCacheOptions.cs b/src/Libraries/Microsoft.Extensions.Caching.Hybrid/HybridCacheOptions.cs
index 982ea55a6af..5020195e3e4 100644
--- a/src/Libraries/Microsoft.Extensions.Caching.Hybrid/HybridCacheOptions.cs
+++ b/src/Libraries/Microsoft.Extensions.Caching.Hybrid/HybridCacheOptions.cs
@@ -11,11 +11,13 @@ public class HybridCacheOptions
private const int ShiftBytesToMibiBytes = 20;
///
- /// Gets or sets the default global options to be applied to operations; if options are
- /// specified at the individual call level, the non-null values are merged (with the per-call
- /// options being used in preference to the global options). If no value is specified for a given
- /// option (globally or per-call), the implementation may choose a reasonable default.
+ /// Gets or sets the default global options to be applied to operations.
///
+ ///
+ /// If options are specified at the individual call level, the non-null values are merged
+ /// (with the per-call options being used in preference to the global options). If no value is
+ /// specified for a given option (globally or per-call), the implementation can choose a reasonable default.
+ ///
public HybridCacheEntryOptions? DefaultEntryOptions { get; set; }
///
@@ -24,21 +26,35 @@ public class HybridCacheOptions
public bool DisableCompression { get; set; }
///
- /// Gets or sets the maximum size of cache items; attempts to store values over this size will be logged
- /// and the value will not be stored in cache.
+ /// Gets or sets the maximum size of cache items.
///
- /// The default value is 1 MiB.
+ ///
+ /// The maximum size of cache items. The default value is 1 MiB.
+ ///
+ ///
+ /// Attempts to store values over this size are logged,
+ /// and the value isn't stored in the cache.
+ ///
public long MaximumPayloadBytes { get; set; } = 1 << ShiftBytesToMibiBytes; // 1MiB
///
- /// Gets or sets the maximum permitted length (in characters) of keys; attempts to use keys over this size will be logged.
+ /// Gets or sets the maximum permitted length (in characters) of keys.
///
- /// The default value is 1024 characters.
+ ///
+ /// The maximum permitted length of keys, in characters. The default value is 1024 characters.
+ ///
+ /// Attempts to use keys over this size are logged.
public int MaximumKeyLength { get; set; } = 1024; // characters
///
- /// Gets or sets a value indicating whether to use "tags" data as dimensions on metric reporting; if enabled, care should be used to ensure that
- /// tags do not contain data that should not be visible in metrics systems.
+ /// Gets or sets a value indicating whether to use "tags" data as dimensions on metric reporting.
///
+ ///
+ /// to use "tags" data as dimensions on metric reporting; otherwise, .
+ ///
+ ///
+ /// If enabled, take care to ensure that tags don't contain data that
+ /// should not be visible in metrics systems.
+ ///
public bool ReportTagMetrics { get; set; }
}
From 79dc8f29c1d32bc872cbc1c80a2bfe96f12f25f6 Mon Sep 17 00:00:00 2001
From: Igor Velikorossov
Date: Thu, 10 Oct 2024 16:56:58 +1100
Subject: [PATCH 2/2] Update
src/Libraries/Microsoft.Extensions.Caching.Hybrid/HybridCacheOptions.cs
---
.../Microsoft.Extensions.Caching.Hybrid/HybridCacheOptions.cs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/Libraries/Microsoft.Extensions.Caching.Hybrid/HybridCacheOptions.cs b/src/Libraries/Microsoft.Extensions.Caching.Hybrid/HybridCacheOptions.cs
index 5020195e3e4..473f1e3c46d 100644
--- a/src/Libraries/Microsoft.Extensions.Caching.Hybrid/HybridCacheOptions.cs
+++ b/src/Libraries/Microsoft.Extensions.Caching.Hybrid/HybridCacheOptions.cs
@@ -50,7 +50,7 @@ public class HybridCacheOptions
/// Gets or sets a value indicating whether to use "tags" data as dimensions on metric reporting.
///
///
- /// to use "tags" data as dimensions on metric reporting; otherwise, .
+ /// to use "tags" data as dimensions on metric reporting; otherwise, .
///
///
/// If enabled, take care to ensure that tags don't contain data that