From 9fcb88e1f9d39f841445c9890bdb61727668466c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= <zoltan.lehoczky@lombiq.com>
Date: Wed, 15 Nov 2023 15:43:39 +0100
Subject: [PATCH] Clarifying docs on StringExtensions that you shouldn't use

---
 .../Extensions/StringExtensions.cs                         | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/Lombiq.HelpfulLibraries.Common/Extensions/StringExtensions.cs b/Lombiq.HelpfulLibraries.Common/Extensions/StringExtensions.cs
index e26def64..98cf0b8b 100644
--- a/Lombiq.HelpfulLibraries.Common/Extensions/StringExtensions.cs
+++ b/Lombiq.HelpfulLibraries.Common/Extensions/StringExtensions.cs
@@ -130,14 +130,15 @@ public static string ReplaceOrdinalIgnoreCase(this string text, string oldValue,
         text.Replace(oldValue, newValue ?? string.Empty, StringComparison.OrdinalIgnoreCase);
 
     /// <summary>
-    /// A shortcut for <c>string.Equals(string, StringComparison.Ordinal)</c>.
+    /// Use simple <see cref="string"/> equality check with <c>=</c> instead, since it already uses ordinal string
+    /// comparison.
     /// </summary>
     [Obsolete("The string equals operator already uses ordinal string comparison.")]
     public static bool EqualsOrdinal(this string text, string? value) =>
         throw new NotSupportedException();
 
     /// <summary>
-    /// A shortcut for <c>string.Contains(string, StringComparison.Ordinal)</c>.
+    /// Use <c>string.Contains(string)</c> instead, since it already uses ordinal string comparison..
     /// </summary>
     [Obsolete("The string.Contains(value) member method already uses ordinal string comparison.")]
     public static bool ContainsOrdinal(this string text, string value) =>
@@ -168,7 +169,7 @@ public static bool EndsWithOrdinal(this string text, string value) =>
         text.EndsWith(value, StringComparison.Ordinal);
 
     /// <summary>
-    /// A shortcut for <c>string.Replace(string, string, StringComparison.Ordinal)</c>.
+    /// Use <c>string.Replace(string, string) instead, since it already uses ordinal string comparison.</c>.
     /// </summary>
     [Obsolete("The string.Replace(oldValue, newValue) member method already uses ordinal string comparison.")]
     public static string ReplaceOrdinal(this string text, string oldValue, string? newValue = "") =>