From 63aa34cb3543ff4af3a57c87f0139037416dc70b Mon Sep 17 00:00:00 2001
From: RoosterDragon <RoosterDragon@outlook.com>
Date: Mon, 20 Feb 2023 10:37:26 +0000
Subject: [PATCH] Fix CS1570

---
 OpenRA.Mods.Common/UpdateRules/UpdateUtils.cs | 4 ++--
 OpenRA.ruleset                                | 1 -
 2 files changed, 2 insertions(+), 3 deletions(-)

diff --git a/OpenRA.Mods.Common/UpdateRules/UpdateUtils.cs b/OpenRA.Mods.Common/UpdateRules/UpdateUtils.cs
index 95791a1bc1..3439e6f736 100644
--- a/OpenRA.Mods.Common/UpdateRules/UpdateUtils.cs
+++ b/OpenRA.Mods.Common/UpdateRules/UpdateUtils.cs
@@ -376,7 +376,7 @@ namespace OpenRA.Mods.Common.UpdateRules
 			return node.Value.Nodes.RemoveAll(n => n.KeyMatches(match, ignoreSuffix, includeRemovals));
 		}
 
-		/// <summary>Returns true if the node is of the form <match> or <match>@arbitrary</summary>
+		/// <summary>Returns true if the node is of the form [match] or [match]@[arbitrary suffix]</summary>
 		public static bool KeyMatches(this MiniYamlNode node, string match, bool ignoreSuffix = true, bool includeRemovals = true)
 		{
 			if (node.Key == null)
@@ -394,7 +394,7 @@ namespace OpenRA.Mods.Common.UpdateRules
 			return atPosition > 0 && node.Key.Substring(0, atPosition) == prefix + match;
 		}
 
-		/// <summary>Returns true if the node is of the form <*match*>, <*match*>@arbitrary or <arbitrary>@*match*</summary>
+		/// <summary>Returns true if the node is of the form [match], [match]@[arbitrary suffix] or [arbitrary suffix]@[match]</summary>
 		public static bool KeyContains(this MiniYamlNode node, string match, bool ignoreSuffix = true, bool includeRemovals = true)
 		{
 			if (node.Key == null)
diff --git a/OpenRA.ruleset b/OpenRA.ruleset
index 95b02fe216..4fd5d88b5a 100644
--- a/OpenRA.ruleset
+++ b/OpenRA.ruleset
@@ -6,7 +6,6 @@
   <!-- Rules related to generating XML documentation that we need to silence. -->
   <!-- These are here because of GenerateDocumentationFile, which is a workaround for forcing rule IDE0005 to work outside of an IDE. -->
   <Rules AnalyzerId="Microsoft.CodeAnalysis.CSharp" RuleNamespace="Microsoft.CodeAnalysis.CSharp">
-    <Rule Id="CS1570" Action="None" /><!-- Invalid XML in XML comment. -->
     <Rule Id="CS1573" Action="None" /><!-- Parameter has no matching param tag in the XML comment. -->
     <Rule Id="CS1591" Action="None" /><!-- Missing XML comment for publicly visible type or member. -->
   </Rules>