Conversation
…tCracker.fs (issue #1035) - SymbolReader.fs: module doc, ReadingContext fields/members, and all key functions (readMemberOrVal, readUnionCase, readFSharpField, readAttribute, readMarkdownCommentAsHtml, readXmlElementAsHtml, readXmlCommentAsHtmlAux, readCommentAndCommands, readCommentsInto, readType, readAssembly, etc.) - TypeFormatter.fs: module doc and all public-facing functions (formatTypeAsHtml, formatConstraintAsText, formatCurriedArgsUsageAsHtml, formatTypeApplicationAsHtml, formatDelegateSignatureAsHtml, etc.) - ProjectCracker.fs: module docs for Utils, DotNetCli, Crack; all utility helpers (getDotnetHostPath, cacheBinary, ensureDirectory, etc.) and CrackedProjectInfo type; crackProjectFile, crackProjects, etc. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This was referenced Mar 8, 2026
dsyme
approved these changes
Mar 8, 2026
dsyme
deleted the
repo-assist/doc-comments-batch4-symbolreader-291a40afd3ba2dc3
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, in response to a
/repo-assistcommand from @dsyme on #1035.Closes #1035 (partial — continues batch work)
Summary
This PR adds
///XML doc comments to the three source files that previously had zero doc comments, covering the three largest zero-comment files in the repo:SymbolReader.fsTypeFormatter.fsProjectCracker.fsSymbolReader.fs
ReadingContextrecord: type-level doc,XmlMemberLookup,CreatereadAttribute,readAttributes,readMemberOrVal,readUnionCase,readFSharpField,getFSharpStaticParamXmlSig,readFSharpStaticParam,removeSpaces,readMarkdownCommentAsHtml,findCommand,readXmlElementAsSingleSummary,readXmlElementAsHtml,readXmlCommentAsHtmlAux,readXmlCommentAsHtml,collectSpanIndirectLinks,collectParagraphIndirectLinks,combineHtml,combineHtmlOptions,combineNamespaceDocs,linkDefined,getTypeLink,addLinkToType,wrapInlineCodeLinksInSpans,wrapInlineCodeLinksInParagraphs,addMissingLinkToTypes,readMarkdownCommentAndCommands,readXmlCommentAndCommands,readCommentAndCommands,readCommentsInto,checkAccess,collectNamespaceDocs,readChildren,tryReadMember,readAllMembers,readMembers,readTypeNameAsText,readUnionCases,readRecordFields,readStaticParams,xmlDocText,registerXmlDoc,registerProvidedTypeXmlDocs,readType,readModule,readEntities,stripMicrosoft,readNamespace,readAssemblyTypeFormatter.fs
convHtml,codeHtml,formatSourceLocation,formatTypeArgumentAsText,formatTypeArgumentsAsText,formatConstraintAsText,formatConstraintsAsText,bracketHtml,bracketNonAtomicHtml,bracketHtmlIf,formatTyconRefAsHtml,formatTypeApplicationAsHtml,formatTypesWithPrecAsHtml,formatTypeWithPrecAsHtml,formatTypeAsHtml,formatArgNameAndTypePair,formatArgNameAndType,formatArgUsageAsHtml,formatArgNameAndTypePairUsageAsHtml,formatCurriedArgsUsageAsHtml,formatDelegateSignatureAsHtmlProjectCracker.fs
Utils,DotNetCli, andCrackUtils:isWindows,dotnet,fileExists,getDotnetGlobalHostPath,getDotnetHostPath,ensureDirectory,saveBinary,loadBinary,cacheBinary,ensureTrailingSlashDotNetCli.msbuildCrack:msbuildPropBool,runProcess,CrackedProjectInfotype,crackProjectFileAndIncludeTargetFrameworks,ensureProjectWasRestored,crackProjectFile,getProjectsFromSlnFile,crackProjectsTest Status
✅ Build succeeded with 0 errors and 0 new warnings:
The single pre-existing warning in
BuildCommand.fs(FS0760) is unrelated to this PR.