Skip to content

Commit 038aad2

Browse files
docs: add missing <returns> XML tags to singleton, isEmpty, length, lengthOrMax, lengthBy, lengthByAsync
Six members in TaskSeq.fsi were missing <returns> XML documentation tags, making the IntelliSense and generated API docs incomplete. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 8f3a22e commit 038aad2

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

release-notes.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ Release notes:
44
1.0.0
55
- adds TaskSeq.withCancellation, #167
66
- adds docs/ with fsdocs-based documentation site covering generating, transforming, consuming, combining and advanced operations
7+
- docs: adds missing XML <returns> documentation tags to singleton, isEmpty, length, lengthOrMax, lengthBy, and lengthByAsync
78

89
0.7.0
910
- performance: TaskSeq.exists, existsAsync, contains no longer allocate an intermediate Option value

src/FSharp.Control.TaskSeq/TaskSeq.fsi

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ type TaskSeq =
102102
/// </summary>
103103
///
104104
/// <param name="value">The input item to use as the single item of the task sequence.</param>
105+
/// <returns>A task sequence containing exactly one element.</returns>
105106
static member singleton: value: 'T -> TaskSeq<'T>
106107

107108
/// <summary>
@@ -119,6 +120,7 @@ type TaskSeq =
119120
/// </summary>
120121
///
121122
/// <param name="source">The input task sequence.</param>
123+
/// <returns>A task returning <c>true</c> if the sequence contains no elements; <c>false</c> otherwise.</returns>
122124
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
123125
static member isEmpty: source: TaskSeq<'T> -> Task<bool>
124126

@@ -128,6 +130,7 @@ type TaskSeq =
128130
/// </summary>
129131
///
130132
/// <param name="source">The input task sequence.</param>
133+
/// <returns>A task returning the number of elements in the sequence.</returns>
131134
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
132135
static member length: source: TaskSeq<'T> -> Task<int>
133136

@@ -139,6 +142,7 @@ type TaskSeq =
139142
///
140143
/// <param name="max">Limit at which to stop evaluating source items for finding the length.</param>
141144
/// <param name="source">The input task sequence.</param>
145+
/// <returns>A task returning the actual length of the sequence, or <paramref name="max" /> if the sequence is longer than <paramref name="max" />.</returns>
142146
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
143147
static member lengthOrMax: max: int -> source: TaskSeq<'T> -> Task<int>
144148

@@ -150,6 +154,7 @@ type TaskSeq =
150154
///
151155
/// <param name="predicate">A function to test whether an item in the input sequence should be included in the count.</param>
152156
/// <param name="source">The input task sequence.</param>
157+
/// <returns>A task returning the number of elements for which <paramref name="predicate" /> returns <c>true</c>.</returns>
153158
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
154159
static member lengthBy: predicate: ('T -> bool) -> source: TaskSeq<'T> -> Task<int>
155160

@@ -161,6 +166,7 @@ type TaskSeq =
161166
///
162167
/// <param name="predicate">A function to test whether an item in the input sequence should be included in the count.</param>
163168
/// <param name="source">The input task sequence.</param>
169+
/// <returns>A task returning the number of elements for which <paramref name="predicate" /> returns <c>true</c>.</returns>
164170
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
165171
static member lengthByAsync: predicate: ('T -> #Task<bool>) -> source: TaskSeq<'T> -> Task<int>
166172

0 commit comments

Comments
 (0)