Conversation
…batch 2 of #1035) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
12 tasks
dsyme
deleted the
repo-assist/issue-1035-comment-code-batch2-fd87fd5f2df80e0b
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), addressing #1035 ("Comment all the code in the repository").
Summary
Adds
///XML doc comments to 3 more source files:GenerateHtml.fsfsdocsSummarydoc,HtmlRendertype docParsePynb.fsParsedCelltype doc,Outputsub-module doc, all 9 public/internal functionsPervasive.fsAsyncMaybeBuildertype doc,liftAsyncdoc,Asyncmodule doc,Async.mapdocComment style followed
/// ...XML doc comments explaining purposeTest Status
✅ Build succeeded:
dotnet build FSharp.Formatting.sln --configuration Release— 0 errors✅ Format:
dotnet fantomas— all 3 source files unchanged (already properly formatted)What's next (future batches)
Larger files still needing comments:
SymbolReader.fs(1332 lines, 12 comments)BuildCommand.fs(waiting for [Repo Assist] Adddotnet fsdocs convertcommand for single-file conversion #1019 to merge first)ToolTipReader.fs(140 lines, 6 comments)GenerateMarkdown.fs(467 lines, 9 comments)FsxFormatting.fs(86 lines, 3 comments)Part of #1035