Conversation
Add XML doc and /// comments to 11 files with zero or minimal documentation: - Range.fs: MarkdownRange public type and module - Log.fs: internal tracing helpers - Menu.fs: navigation menu generation - PageContentList.fs: table-of-contents builder - MarkdownFormatting.fs: markdown re-serialization - MarkdownModel.fs: Dsl module + MarkdownPatterns types/active patterns - Constants.fs: CSS token class name constants - GenerateSearchIndex.fs: search index builder - Categorise.fs: entity/member category grouping - Options.fs: fsdocs CLI shared utilities - Program.fs: fsdocs entry point Part of the ongoing effort tracked in #1035. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
dsyme
approved these changes
Feb 26, 2026
This was referenced Feb 26, 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
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.
Part of #1035 — "Comment all the code in the repository".
Summary
This is the first batch of
///documentation comments added to files with zero or minimal existing documentation. It covers 11 files across the codebase:FSharp.Formatting.Common/Range.fsMarkdownRangepublic struct +MarkdownRangemoduleFSharp.Formatting.Common/Log.fsFSharp.Formatting.Common/Menu.fsFSharp.Formatting.Common/PageContentList.fsFSharp.Formatting.Markdown/MarkdownFormatting.fsFSharp.Formatting.Markdown/MarkdownModel.fsDslmodule docs,MarkdownPatternstype/AP docs,MarkdownParseOptionsenum member docsFSharp.Formatting.CodeFormat/Constants.fsFSharp.Formatting.ApiDocs/GenerateSearchIndex.fsFSharp.Formatting.ApiDocs/Categorise.fsfsdocs-tool/Options.fsfsdocs-tool/Program.fsComment style followed
/// <summary>...</summary>comments/// ...commentsTest Status
Build: ✅
dotnet build FSharp.Formatting.sln --configuration Release— succeeded with 0 errorsFormat: ✅
dotnet fantomas ...— all 11 source files pass Fantomas checkWhat's next (future batches)
Larger files needing comments next:
CrossReferenceResolver.fs(367 lines, 0 comments)GenerateHtml.fs(644 lines, 2 comments)GenerateMarkdown.fs(350 lines, 1 comment)PynbModel.fs(208 lines, 0 comments)HtmlModel.fs(737 lines, 2 comments)SymbolReader.fs(1332 lines, 12 comments)BuildCommand.fs(1855 lines, 8 comments)Fixes Comment all the code in the repository #1035