Skip to content

[Repo Assist] docs: add missing (returns) XML tags to singleton, isEmpty, length, lengthOrMax, lengthBy, lengthByAsync#347

Draft
github-actions[bot] wants to merge 2 commits intomainfrom
repo-assist/improve-xmldoc-returns-tags-20260316-57d9cdc0fc84d55c
Draft

[Repo Assist] docs: add missing (returns) XML tags to singleton, isEmpty, length, lengthOrMax, lengthBy, lengthByAsync#347
github-actions[bot] wants to merge 2 commits intomainfrom
repo-assist/improve-xmldoc-returns-tags-20260316-57d9cdc0fc84d55c

Conversation

@github-actions
Copy link
Contributor

🤖 This PR was created by Repo Assist, an automated AI assistant.

Summary

Six members in TaskSeq.fsi were missing (returns) XML documentation tags, making IntelliSense tooltips and generated API docs incomplete for these functions.

Function Return type Added (returns) text
singleton TaskSeq<'T> "A task sequence containing exactly one element."
isEmpty Task(bool) "A task returning true if the sequence contains no elements; false otherwise."
length Task(int) "A task returning the number of elements in the sequence."
lengthOrMax Task(int) "A task returning the actual length of the sequence, or max if the sequence is longer than max."
lengthBy Task(int) "A task returning the number of elements for which predicate returns true."
lengthByAsync Task(int) Same as lengthBy.

All other members already had (returns) tags; these were simply overlooked.

Changes

File Change
TaskSeq.fsi Added 6 (returns) tags
release-notes.txt Updated under 1.0.0

Trade-offs

Documentation-only change; no runtime behaviour is affected.

Test Status

✅ Build: dotnet build src/FSharp.Control.TaskSeq.sln -c Releasesucceeded, 0 warnings, 0 errors
✅ Format: dotnet fantomas src/FSharp.Control.TaskSeq/TaskSeq.fsiunchanged (already formatted)
No tests need updating for a documentation-only change.

Generated by Repo Assist

Generated by Repo Assist ·

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/repo-assist.md@346204513ecfa08b81566450d7d599556807389f

…engthOrMax, 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants