Skip to content

Commit 288e5f6

Browse files
committed
Deprecate the alias taskSeq<'T>, intro TaskSeq<'T> in its stead
1 parent 6d121f0 commit 288e5f6

File tree

3 files changed

+14
-1
lines changed

3 files changed

+14
-1
lines changed

release-notes.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
Release notes:
33
0.4.x (unreleased)
44
- fix documentation, improve tooltips experience, add exception info to every method
5+
- 'TaskSeq<'T>' now replaces 'taskSeq<'T>'
6+
- DEPRECATED: type alias 'taskSeq<'T>' now raises warning FS0044 in favor of 'TaskSeq<'T>'
57
- BINARY INCOMPATIBLE: TaskSeq module members are now static members, source code compatible, #186
68

79
0.4.0-alpha.1

src/FSharp.Control.TaskSeq/TaskSeqBuilder.fs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,11 @@ module Internal = // cannot be marked with 'internal' scope
4141
NotImplementedException "Abstract Class: method or property not implemented"
4242
|> raise
4343

44+
[<Obsolete "From version 0.4.0 onward, 'taskSeq<'T>' is deprecated in favor of 'TaskSeq<'T>'. It will be removed in an upcoming release.">]
4445
type taskSeq<'T> = IAsyncEnumerable<'T>
4546

47+
type TaskSeq<'T> = IAsyncEnumerable<'T>
48+
4649

4750
[<NoComparison; NoEquality>]
4851
type TaskSeqStateMachineData<'T>() =

src/FSharp.Control.TaskSeq/TaskSeqBuilder.fsi

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,18 @@ module Internal =
2525
val inline raiseNotImpl: unit -> 'a
2626

2727
/// <summary>
28-
/// Result of any <see cref="taskSeq" /> computation expression, alias for <see cref="T:System.IAsyncEnumerable&lt;'T&gt;" />.
28+
/// The type <paramref name="taskSeq&lt;_>" /> is deprecated since version 0.4.0,
29+
/// please use <paramref name="TaskSeq&lt;_>" /> in its stead. See <see cref="T:FSharp.Control.TaskSeq&lt;_>" />.
2930
/// </summary>
31+
[<Obsolete "From version 0.4.0 onward, 'taskSeq<_>' is deprecated in favor of 'TaskSeq<_>'. It will be removed in an upcoming release.">]
3032
type taskSeq<'T> = IAsyncEnumerable<'T>
3133

34+
/// <summary>
35+
/// Represents a <see cref="task sequence" /> and is the output of using the <paramref name="taskSeq{...}" />
36+
/// computation expression from this library. It is an alias for <see cref="T:System.IAsyncEnumerable&lt;_>" />.
37+
/// </summary>
38+
type TaskSeq<'T> = IAsyncEnumerable<'T>
39+
3240
/// TaskSeqCode type alias of ResumableCode delegate type, specially recognized by the F# compiler
3341
and ResumableTSC<'T> = ResumableCode<TaskSeqStateMachineData<'T>, unit>
3442

0 commit comments

Comments
 (0)