Cleanup CompletedTask

fsprojects · Apr 6, 2024 · 41b6733 · 41b6733
1 parent 57246d6
commit 41b6733
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 5 deletions.
diff --git a/src/FSharp.Control.TaskSeq/Utils.fs b/src/FSharp.Control.TaskSeq/Utils.fs
@@ -5,13 +5,10 @@ open System
 
 [<AutoOpen>]
 module ValueTaskExtensions =
-    /// Extensions for ValueTask that are not available in NetStandard 2.1, but are
-    /// available in .NET 5+. We put them in Extension space to mimic the behavior of NetStandard 2.1
     type ValueTask with
 
-        /// (Extension member) Gets a task that has already completed successfully.
         static member inline CompletedTask =
-            // This mimics how it is done in .NET itself
+            // This mimics how it is done in net5.0 and later internally
             Unchecked.defaultof<ValueTask>
 
 

diff --git a/src/FSharp.Control.TaskSeq/Utils.fsi b/src/FSharp.Control.TaskSeq/Utils.fsi
@@ -6,9 +6,11 @@ open System.Threading.Tasks.Sources
 
 [<AutoOpen>]
 module ValueTaskExtensions =
+
+    /// Shims back-filling .NET 5+ functionality for use on netstandard2.1
     type ValueTask with
 
-        /// (Extension member) Gets a task that has already completed successfully.
+        /// (Extension member) Gets a ValueTask that has already completed successfully.
         static member inline CompletedTask: ValueTask
 
 module ValueTask =