Skip to content

Commit df2db16

Browse files
committed
Remove doc comments from implementation file, we have the sign file already
1 parent aa36f28 commit df2db16

File tree

1 file changed

+0
-32
lines changed

1 file changed

+0
-32
lines changed

src/FSharp.Control.TaskSeq/Utils.fs

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -18,28 +18,22 @@ module ValueTaskExtensions =
1818

1919

2020
module ValueTask =
21-
/// A successfully completed ValueTask of boolean that has the value false.
2221
let False = ValueTask<bool>()
2322

24-
/// A successfully completed ValueTask of boolean that has the value true.
2523
let True = ValueTask<bool> true
2624

27-
/// Creates a ValueTask with the supplied result of the successful operation.
2825
let inline fromResult (value: 'T) = ValueTask<'T> value
2926

3027
[<Obsolete "From version 0.4.0 onward, 'ValueTask.FromResult' is deprecated in favor of 'ValueTask.fromResult'. It will be removed in an upcoming release.">]
3128
let inline FromResult (value: 'T) = ValueTask<'T> value
3229

33-
/// Creates a ValueTask with an IValueTaskSource representing the operation
3430
let inline ofSource taskSource version = ValueTask<bool>(taskSource, version)
3531

3632
[<Obsolete "From version 0.4.0 onward, 'ValueTask.ofIValueTaskSource' is deprecated in favor of 'ValueTask.ofSource'. It will be removed in an upcoming release.">]
3733
let inline ofIValueTaskSource taskSource version = ofSource taskSource version
3834

39-
/// Creates a ValueTask form a Task<'T>
4035
let inline ofTask (task: Task<'T>) = ValueTask<'T> task
4136

42-
/// Ignore a ValueTask<'T>, returns a non-generic ValueTask.
4337
let inline ignore (vtask: ValueTask<'T>) =
4438
// this implementation follows Stephen Toub's advice, see:
4539
// https://github.com/dotnet/runtime/issues/31503#issuecomment-554415966
@@ -51,28 +45,13 @@ module ValueTask =
5145
ValueTask(vtask.AsTask())
5246

5347
module Task =
54-
/// Convert an Async<'T> into a Task<'T>
5548
let inline ofAsync (async: Async<'T>) = task { return! async }
56-
57-
/// Convert a unit-task into a Task<unit>
5849
let inline ofTask (task': Task) = task { do! task' }
59-
60-
/// Convert a non-task function into a task-returning function
6150
let inline apply (func: _ -> _) = func >> Task.FromResult
62-
63-
/// Convert a Task<'T> into an Async<'T>
6451
let inline toAsync (task: Task<'T>) = Async.AwaitTask task
65-
66-
/// Convert a Task<'T> into a ValueTask<'T>
6752
let inline toValueTask (task: Task<'T>) = ValueTask<'T> task
68-
69-
/// <summary>
70-
/// Convert a ValueTask&lt;'T> to a Task&lt;'T>. To use a non-generic ValueTask,
71-
/// consider using: <paramref name="myValueTask |> Task.ofValueTask |> Task.ofTask" />.
72-
/// </summary>
7353
let inline ofValueTask (valueTask: ValueTask<'T>) = task { return! valueTask }
7454

75-
/// Convert a Task<'T> into a non-generic Task, ignoring the result
7655
let inline ignore (task: Task<'T>) =
7756
TaskBuilder.task {
7857
// ensure the task is awaited
@@ -81,42 +60,31 @@ module Task =
8160
}
8261
:> Task
8362

84-
/// Map a Task<'T>
8563
let inline map mapper (task: Task<'T>) : Task<'U> = TaskBuilder.task {
8664
let! result = task
8765
return mapper result
8866
}
8967

90-
/// Bind a Task<'T>
9168
let inline bind binder (task: Task<'T>) : Task<'U> = TaskBuilder.task {
9269
let! t = task
9370
return! binder t
9471
}
9572

96-
/// Create a task from a value
9773
let inline fromResult (value: 'U) : Task<'U> = Task.FromResult value
9874

9975
module Async =
100-
/// Convert an Task<'T> into an Async<'T>
10176
let inline ofTask (task: Task<'T>) = Async.AwaitTask task
102-
103-
/// Convert a unit-task into an Async<unit>
10477
let inline ofUnitTask (task: Task) = Async.AwaitTask task
105-
106-
/// Convert a Task<'T> into an Async<'T>
10778
let inline toTask (async: Async<'T>) = task { return! async }
10879

109-
/// Convert an Async<'T> into an Async<unit>, ignoring the result
11080
let inline ignore (async': Async<'T>) = async {
11181
let! _ = async'
11282
return ()
11383
}
11484

115-
/// Map an Async<'T>
11685
let inline map mapper (async: Async<'T>) : Async<'U> = ExtraTopLevelOperators.async {
11786
let! result = async
11887
return mapper result
11988
}
12089

121-
/// Bind an Async<'T>
12290
let inline bind binder (task: Async<'T>) : Async<'U> = ExtraTopLevelOperators.async { return! binder task }

0 commit comments

Comments
 (0)