Conversation
- ParseScript.fs: add docs for splitLines, getVisibility, getEvaluate, getParaOptions - Transformations.fs: add module doc, fix misleading doc on replaceHtmlTaggedCode - LatexFormatting.fs: add module doc and latexEncode doc - SourceCode.fs: add CodeFormatHelper module doc and defaultTokenMap doc - CommentFilter.fs: add module-level doc comment Part of #1035 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
dsyme
approved these changes
Feb 27, 2026
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.
Continues work from #1037 (batch 1, merged), #1043 (batch 2a, merged), #1048 (batch 2b, merged), and #1049 (batch 3, merged), addressing #1035 ("Comment all the code in the repository").
Summary
Adds
///XML doc comments to 5 more source files:ParseScript.fssplitLines,getVisibility,getEvaluate,getParaOptionsTransformations.fsreplaceHtmlTaggedCodeLatexFormatting.fslatexEncodedocSourceCode.fsCodeFormatHelpermodule doc;defaultTokenMapdocCommentFilter.fsNotes
replaceHtmlTaggedCodefunction inTransformations.fshad a copy-pasted doc string fromreplaceLiterateParagraph— corrected to accurately describe what the function does.Test Status
✅ Build succeeded:
dotnet build FSharp.Formatting.sln --configuration Release— 0 errors✅ Format:
dotnet fantomas— all 5 files unchanged after formatting checkWhat's next (future batches)
Larger files still needing comments:
SymbolReader.fs(1621 lines) — largest remaining targetParseScript.fs/Transformations.fs— already substantially documented but a few private helpers could still benefitMarkdownParser.fs1470 lines,YaafFSharpScripting.fs1123 lines)BuildCommand.fs— waiting for [Repo Assist] Adddotnet fsdocs convertcommand for single-file conversion #1019 to merge firstPart of #1035