diff --git a/release-notes.txt b/release-notes.txt index 3a43519..f97115a 100644 --- a/release-notes.txt +++ b/release-notes.txt @@ -11,6 +11,7 @@ Release notes: - adds TaskSeq.chunkBy, chunkByAsync, #345 - adds TaskSeq.threadState, threadStateAsync, #345 - adds docs/ with fsdocs-based documentation site covering generating, transforming, consuming, combining and advanced operations + - docs: adds missing XML documentation tags to singleton, isEmpty, length, lengthOrMax, lengthBy, and lengthByAsync - test: adds 70 new tests to TaskSeq.Fold.Tests.fs covering call-count assertions, folder-not-called-on-empty, ordering, null initial state, and fold/foldAsync equivalence 0.7.0 diff --git a/src/FSharp.Control.TaskSeq/TaskSeq.fsi b/src/FSharp.Control.TaskSeq/TaskSeq.fsi index ca3a19d..f914048 100644 --- a/src/FSharp.Control.TaskSeq/TaskSeq.fsi +++ b/src/FSharp.Control.TaskSeq/TaskSeq.fsi @@ -102,6 +102,7 @@ type TaskSeq = /// /// /// The input item to use as the single item of the task sequence. + /// A task sequence containing exactly one element. static member singleton: value: 'T -> TaskSeq<'T> /// @@ -152,6 +153,7 @@ type TaskSeq = /// /// /// The input task sequence. + /// A task returning true if the sequence contains no elements; false otherwise. /// Thrown when the input task sequence is null. static member isEmpty: source: TaskSeq<'T> -> Task @@ -161,6 +163,7 @@ type TaskSeq = /// /// /// The input task sequence. + /// A task returning the number of elements in the sequence. /// Thrown when the input task sequence is null. static member length: source: TaskSeq<'T> -> Task @@ -172,6 +175,7 @@ type TaskSeq = /// /// Limit at which to stop evaluating source items for finding the length. /// The input task sequence. + /// A task returning the actual length of the sequence, or if the sequence is longer than . /// Thrown when the input task sequence is null. static member lengthOrMax: max: int -> source: TaskSeq<'T> -> Task @@ -183,6 +187,7 @@ type TaskSeq = /// /// A function to test whether an item in the input sequence should be included in the count. /// The input task sequence. + /// A task returning the number of elements for which returns true. /// Thrown when the input task sequence is null. static member lengthBy: predicate: ('T -> bool) -> source: TaskSeq<'T> -> Task @@ -194,6 +199,7 @@ type TaskSeq = /// /// A function to test whether an item in the input sequence should be included in the count. /// The input task sequence. + /// A task returning the number of elements for which returns true. /// Thrown when the input task sequence is null. static member lengthByAsync: predicate: ('T -> #Task) -> source: TaskSeq<'T> -> Task