From e058ab75bc229b21d02c7448661db911a90b548e Mon Sep 17 00:00:00 2001
From: Oliver Booth <me@olivr.me>
Date: Mon, 25 Apr 2022 22:21:08 +0100
Subject: [PATCH] Obsolesce WaitOneAsync

TaskCompletionSource is recommended for execution suspension while waiting for an asynchronous operation to complete
---
 .../WaitHandleExtensions.cs                            | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)
 rename X10D/src/{WaitHandleExtensions => Threading}/WaitHandleExtensions.cs (60%)

diff --git a/X10D/src/WaitHandleExtensions/WaitHandleExtensions.cs b/X10D/src/Threading/WaitHandleExtensions.cs
similarity index 60%
rename from X10D/src/WaitHandleExtensions/WaitHandleExtensions.cs
rename to X10D/src/Threading/WaitHandleExtensions.cs
index 9e58719..06225e4 100644
--- a/X10D/src/WaitHandleExtensions/WaitHandleExtensions.cs
+++ b/X10D/src/Threading/WaitHandleExtensions.cs
@@ -1,7 +1,7 @@
-namespace X10D;
+namespace X10D.Threading;
 
 /// <summary>
-///     Extension methods for <see cref="WaitHandle" />.
+///     Threading-related extension methods for <see cref="WaitHandle" />.
 /// </summary>
 public static class WaitHandleExtensions
 {
@@ -13,6 +13,12 @@ public static class WaitHandleExtensions
     ///     <see langword="true" /> if the current instance receives a signal. If the current instance is never signaled,
     ///     <see cref="WaitOneAsync" /> never returns.
     /// </returns>
+    /// <remarks>
+    ///     It is heavily recommended that the use of this method is minimal, or non-existent. For suspension of execution when
+    ///     performing an asynchronous operation, use <see cref="TaskCompletionSource" /> or
+    ///     <see cref="TaskCompletionSource{TResult}" />.
+    /// </remarks>
+    [Obsolete("Consider using a TaskCompletionSource instead.")]
     public static Task<bool> WaitOneAsync(this WaitHandle handle)
     {
         if (handle is null)