diff --git a/release-notes.txt b/release-notes.txt index 6f7379e..c2b27ed 100644 --- a/release-notes.txt +++ b/release-notes.txt @@ -4,6 +4,7 @@ Release notes: 1.0.0 - adds TaskSeq.withCancellation, #167 - 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 0.7.0 - performance: TaskSeq.exists, existsAsync, contains no longer allocate an intermediate Option value diff --git a/src/FSharp.Control.TaskSeq/TaskSeq.fsi b/src/FSharp.Control.TaskSeq/TaskSeq.fsi index ef34390..4a9b5ec 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> /// @@ -119,6 +120,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 @@ -128,6 +130,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 @@ -139,6 +142,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 @@ -150,6 +154,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 @@ -161,6 +166,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