[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
Conversation
…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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🤖 This PR was created by Repo Assist, an automated AI assistant.
Summary
Six members in
TaskSeq.fsiwere missing(returns)XML documentation tags, making IntelliSense tooltips and generated API docs incomplete for these functions.(returns)textsingletonTaskSeq<'T>isEmptyTask(bool)trueif the sequence contains no elements;falseotherwise."lengthTask(int)lengthOrMaxTask(int)maxif the sequence is longer thanmax."lengthByTask(int)predicatereturnstrue."lengthByAsyncTask(int)lengthBy.All other members already had
(returns)tags; these were simply overlooked.Changes
TaskSeq.fsi(returns)tagsrelease-notes.txt1.0.0Trade-offs
Documentation-only change; no runtime behaviour is affected.
Test Status
✅ Build:
dotnet build src/FSharp.Control.TaskSeq.sln -c Release— succeeded, 0 warnings, 0 errors✅ Format:
dotnet fantomas src/FSharp.Control.TaskSeq/TaskSeq.fsi— unchanged (already formatted)No tests need updating for a documentation-only change.