From d072f1d08d2e045e7546edc20df60959a4193032 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Mon, 10 Jan 2022 12:54:24 +0900
Subject: [PATCH] Add mention to detach methods of only running once

---
 osu.Game/Database/RealmObjectExtensions.cs | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/osu.Game/Database/RealmObjectExtensions.cs b/osu.Game/Database/RealmObjectExtensions.cs
index e5177823ba..e09f046421 100644
--- a/osu.Game/Database/RealmObjectExtensions.cs
+++ b/osu.Game/Database/RealmObjectExtensions.cs
@@ -26,6 +26,9 @@ namespace osu.Game.Database
         /// <summary>
         /// Create a detached copy of the each item in the collection.
         /// </summary>
+        /// <remarks>
+        /// Items which are already detached (ie. not managed by realm) will not be modified.
+        /// </remarks>
         /// <param name="items">A list of managed <see cref="RealmObject"/>s to detach.</param>
         /// <typeparam name="T">The type of object.</typeparam>
         /// <returns>A list containing non-managed copies of provided items.</returns>
@@ -42,6 +45,9 @@ namespace osu.Game.Database
         /// <summary>
         /// Create a detached copy of the item.
         /// </summary>
+        /// <remarks>
+        /// If the item if already detached (ie. not managed by realm) it will not be detached again and the original instance will be returned. This allows this method to be potentially called at multiple levels while only incurring the clone overhead once.
+        /// </remarks>
         /// <param name="item">The managed <see cref="RealmObject"/> to detach.</param>
         /// <typeparam name="T">The type of object.</typeparam>
         /// <returns>A non-managed copy of provided item. Will return the provided item if already detached.</returns>