Conversation
Add XML doc and /// comments to 4 files with minimal documentation: - ToolTipReader.fs: module-level doc, linesFromTaggedText - FsxFormatting.fs: module-level doc, formatAsFsx - MarkdownUtils.fs: module-level doc, isCode, isCodeOutput, getExecutionCount, getCode, getCodeOutput, splitParagraphs, adjustFsxCodeForConditionalDefines, applySubstitutionsInText, applyCodeReferenceResolver, applyDirectLinkResolver, mapText, mapInlineCode, mapDirectLink, mapSpans, mapParagraphs, applySubstitutionsInMarkdown - Formatting.fs: module-level doc, transformDocument Part of the ongoing effort tracked in #1035. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
12 tasks
dsyme
approved these changes
Feb 27, 2026
dsyme
deleted the
repo-assist/issue-1035-comment-code-batch3-1772189271-4e2f44ac97a8ffeb
branch
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
1 participant
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.
Continues work from #1037 (batch 1, merged) and #1043 (batch 2, merged), addressing #1035 ("Comment all the code in the repository").
Summary
Adds
///XML doc comments to 4 more source files:ToolTipReader.fslinesFromTaggedTextFsxFormatting.fsformatAsFsxMarkdownUtils.fsFormatting.fstransformDocumentComment style followed
Test Status
✅ Build succeeded:
dotnet build FSharp.Formatting.sln --configuration Release— 0 errors✅ Format:
dotnet fantomas— all 4 files unchanged after formatting checkWhat's next (future batches)
Larger files still needing comments:
SymbolReader.fs(1621 lines, 15 comments) — largest remaining targetBuildCommand.fs— waiting for [Repo Assist] Adddotnet fsdocs convertcommand for single-file conversion #1019 to merge firstParseScript.fs(453 lines, 20 comments)Transformations.fs(620 lines, 39 comments)Part of #1035