Conversation
- ApiDocTypes.fs (708 lines): public API types and Utils module - CrossReferenceResolver.fs (448 lines): cross-reference resolution - TypeFormatter.fs (225 lines): FCS type → HTML formatting - SymbolReader.fs (1621 lines): assembly/symbol reading logic - GenerateModel.fs (327 lines): ApiDocInput, ApiDocModel, obsolete aliases All 72 ApiDocs tests pass. Addresses #1022 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This was referenced Feb 26, 2026
Contributor
|
@nojaf Will merge to avoid merge conflicts |
dsyme
approved these changes
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.
Addresses #1022 (continuing work on splitting large files).
Summary
GenerateModel.fswas a monolithic 3232-line file. This PR splits it into 5 cohesive files with clear responsibilities:ApiDocTypes.fsApiDoc*types,ApiDocFileExtensionsCrossReferenceResolver.fsCrossReferencesmodule,CrefReference,CrossReferenceResolverTypeFormatter.fsTypeFormattermodule (FCS type → HTML)SymbolReader.fsSymbolReadermodule (assembly/symbol → API docs model)GenerateModel.fsApiDocInput,ApiDocModel, obsolete aliasesApproach
The split follows the natural dependency order in the F# compilation pipeline:
Each file uses
namespace rec FSharp.Formatting.ApiDocsand includes the necessaryopendeclarations.ApiDocFileExtensionswas moved toApiDocTypes.fs(from the bottom ofGenerateModel.fs) to resolve a type inference issue that arose from file ordering.Test Status
✅ Build succeeds:
dotnet build FSharp.Formatting.sln --configuration Release— 0 errors, 0 warnings (excluding pre-existing NU1904 advisory)✅ All 72 ApiDocs tests pass:
dotnet test tests/FSharp.ApiDocs.Tests/FSharp.ApiDocs.Tests.fsproj✅ Code formatted with Fantomas
Previous Attempt
The previous split PR (#1029) was closed due to a conflict — it was based on a stale
mainbefore many PRs landed. This PR is freshly branched from the currentmain.