From 26431006448c9d192ac5931fc1fc3cf10f76c2a9 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Sat, 29 Apr 2023 11:05:10 +0900
Subject: [PATCH] Add xmldoc to new test mentioning failure rate and general
 purpose

---
 .../Visual/Navigation/TestSceneBeatmapEditorNavigation.cs | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/osu.Game.Tests/Visual/Navigation/TestSceneBeatmapEditorNavigation.cs b/osu.Game.Tests/Visual/Navigation/TestSceneBeatmapEditorNavigation.cs
index 554da36cc4..603573058e 100644
--- a/osu.Game.Tests/Visual/Navigation/TestSceneBeatmapEditorNavigation.cs
+++ b/osu.Game.Tests/Visual/Navigation/TestSceneBeatmapEditorNavigation.cs
@@ -12,6 +12,14 @@ namespace osu.Game.Tests.Visual.Navigation
 {
     public partial class TestSceneBeatmapEditorNavigation : OsuGameTestScene
     {
+        /// <summary>
+        /// When entering the editor, a new beatmap is created as part of the asynchronous load process.
+        /// This test ensures that in the case of an early exit from the editor (ie. while it's still loading)
+        /// doesn't leave a dangling beatmap behind.
+        ///
+        /// This may not fail 100% due to timing, but has a pretty high chance of hitting a failure so works well enough
+        /// as a test.
+        /// </summary>
         [Test]
         public void TestCancelNavigationToEditor()
         {