Deprecate minor utility functions

release-notes.txt

@@ -2,9 +2,12 @@
 Release notes:
 0.4.x (unreleased)
     - overhaul all doc comments, add exceptions, improve editor experience, #136
-    - DEPRECATED: 'taskSeq<_>' renamed to 'TaskSeq<_>', 'taskSeq' warns with FS0044, #187
-    - BINARY INCOMPATIBILITY: 'TaskSeq' module is now static members on 'TaskSeq<_>', fixes #184
     - Performance: less thread hops with 'StartImmediateAsTask' instead of 'StartAsTask', fixes #135
+    - BINARY INCOMPATIBILITY: 'TaskSeq' module is now static members on 'TaskSeq<_>', fixes #184
+    - DEPRECATIONS (these raise warning FS0044): 
+      - type 'taskSeq<_>' is renamed to 'TaskSeq<_>', fixes #193
+      - function 'ValueTask.ofIValueTaskSource` renamed to `ValueTask.ofSource`, fixes #193
+      - function `ValueTask.FromResult` is renamed to `ValueTask.fromResult`, fixes #193
 
 0.4.0-alpha.1
     - fixes not calling Dispose for 'use!', 'use', or `finally` blocks #157 (by @bartelink)

src/FSharp.Control.TaskSeq/Utils.fs

@@ -12,7 +12,9 @@ module ValueTaskExtensions =
     type ValueTask with
 
         /// (Extension member) Gets a task that has already completed successfully.
-        static member inline CompletedTask = Unchecked.defaultof<ValueTask>
+        static member inline CompletedTask =
+            // This mimics how it is done in .NET itself
+            Unchecked.defaultof<ValueTask>
 
 
 module ValueTask =
@@ -23,13 +25,19 @@ module ValueTask =
     let True = ValueTask<bool> true
 
     /// Creates a ValueTask with the supplied result of the successful operation.
+    let inline fromResult (x: 'T) = ValueTask<'T> x
+
+    [<Obsolete "From version 0.4.0 onward, 'ValueTask.FromResult' is deprecated in favor of 'ValueTask.fromResult'. It will be removed in an upcoming release.">]
     let inline FromResult (x: 'T) = ValueTask<'T> x
 
     /// Creates a ValueTask with an IValueTaskSource representing the operation
-    let inline ofIValueTaskSource taskSource version = ValueTask<bool>(taskSource, version)
+    let inline ofSource taskSource version = ValueTask<bool>(taskSource, version)
+
+    [<Obsolete "From version 0.4.0 onward, 'ValueTask.ofIValueTaskSource' is deprecated in favor of 'ValueTask.ofSource'. It will be removed in an upcoming release.">]
+    let inline ofIValueTaskSource taskSource version = ofSource taskSource version
 
     /// Creates a ValueTask form a Task<'T>
-    let inline ofTask (task: Task<'T>) = ValueTask<'T>(task)
+    let inline ofTask (task: Task<'T>) = ValueTask<'T> task
 
     /// Ignore a ValueTask<'T>, returns a non-generic ValueTask.
     let inline ignore (vtask: ValueTask<'T>) =
@@ -86,7 +94,7 @@ module Task =
     }
 
     /// Create a task from a value
-    let inline fromResult (value: 'U) : Task<'U> = TaskBuilder.task { return value }
+    let inline fromResult (value: 'U) : Task<'U> = Task.FromResult value
 
 module Async =
     /// Convert an Task<'T> into an Async<'T>

src/FSharp.Control.TaskSeq/Utils.fsi

@@ -1,6 +1,6 @@
 namespace FSharp.Control
 
-open System.Diagnostics
+open System
 open System.Threading.Tasks
 open System.Threading.Tasks.Sources
 
@@ -20,9 +20,26 @@ module ValueTask =
     val True: ValueTask<bool>
 
     /// Creates a ValueTask with the supplied result of the successful operation.
+    val inline fromResult: x: 'T -> ValueTask<'T>
+
+    /// <summary>
+    /// The function <paramref name="FromResult" /> is deprecated since version 0.4.0,
+    /// please use <paramref name="fromSource" /> in its stead. See <see cref="T:FSharp.Control.ValueTask.fromResult" />.
+    /// </summary>
+    [<Obsolete "From version 0.4.0 onward, 'ValueTask.FromResult' is deprecated in favor of 'ValueTask.fromResult'. It will be removed in an upcoming release.">]
     val inline FromResult: x: 'T -> ValueTask<'T>
 
-    /// Creates a ValueTask with an IValueTaskSource representing the operation
+    /// <summary>
+    /// Initialized a new instance of <see cref="ValueTask" /> with an <see cref="IValueTaskSource" /> representing
+    /// representing its operation.
+    /// </summary>
+    val inline ofSource: taskSource: IValueTaskSource<bool> -> version: int16 -> ValueTask<bool>
+
+    /// <summary>
+    /// The function <paramref name="ofIValueTaskSource" /> is deprecated since version 0.4.0,
+    /// please use <paramref name="ofSource" /> in its stead. See <see cref="T:FSharp.Control.ValueTask.ofSource" />.
+    /// </summary>
+    [<Obsolete "From version 0.4.0 onward, 'ValueTask.ofIValueTaskSource' is deprecated in favor of 'ValueTask.ofSource'. It will be removed in an upcoming release.">]
     val inline ofIValueTaskSource: taskSource: IValueTaskSource<bool> -> version: int16 -> ValueTask<bool>
 
     /// Creates a ValueTask form a Task<'T>