Skip to content

[Repo Assist] Add /// doc comments to batch 4 modules (#1035)#1050

Merged
dsyme merged 2 commits intomainfrom
repo-assist/issue-1035-comment-code-batch4-1772190673-4742966fb22066dc
Feb 27, 2026
Merged

[Repo Assist] Add /// doc comments to batch 4 modules (#1035)#1050
dsyme merged 2 commits intomainfrom
repo-assist/issue-1035-comment-code-batch4-1772190673-4742966fb22066dc

Conversation

@github-actions
Copy link
Contributor

🤖 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:

File What was added
ParseScript.fs Docs for splitLines, getVisibility, getEvaluate, getParaOptions
Transformations.fs Module-level doc; fixed copy-paste doc on replaceHtmlTaggedCode
LatexFormatting.fs Module-level doc; latexEncode doc
SourceCode.fs CodeFormatHelper module doc; defaultTokenMap doc
CommentFilter.fs Module-level doc explaining the three special comment forms it handles

Notes

  • The replaceHtmlTaggedCode function in Transformations.fs had a copy-pasted doc string from replaceLiterateParagraph — corrected to accurately describe what the function does.
  • All changes are pure documentation; no logic was altered.

Test Status

✅ Build succeeded: dotnet build FSharp.Formatting.sln --configuration Release — 0 errors
✅ Format: dotnet fantomas — all 5 files unchanged after formatting check

What's next (future batches)

Larger files still needing comments:

  • SymbolReader.fs (1621 lines) — largest remaining target
  • ParseScript.fs / Transformations.fs — already substantially documented but a few private helpers could still benefit
  • Various CodeFormat back-end files (MarkdownParser.fs 1470 lines, YaafFSharpScripting.fs 1123 lines)
  • BuildCommand.fs — waiting for [Repo Assist] Add dotnet fsdocs convert command for single-file conversion #1019 to merge first

Part of #1035

Generated by Repo Assist for issue #1035

To install this agentic workflow, run

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

- 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 dsyme marked this pull request as ready for review February 27, 2026 11:26
@dsyme dsyme merged commit 757f75f into main Feb 27, 2026
4 checks passed
@dsyme dsyme deleted the repo-assist/issue-1035-comment-code-batch4-1772190673-4742966fb22066dc branch February 27, 2026 11:27
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.

Comment all the code in the repository

1 participant