Conversation
…docs (issue #944) Adds a minimal test library `SameNameLib` with a single type named `SameNameLib.SameNameLib` (type name = namespace name), and a test that verifies the type is correctly included in the generated API docs. The test confirms that the bug reported in #944 is not present in the current codebase — the type appears in the namespace's entity list with a non-empty URL base name. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
10 tasks
…espace-regression-4b3f21f63a669691
dsyme
approved these changes
Mar 14, 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
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 is an automated PR from Repo Assist.
Closes #944
Problem
Issue #944 reports that types whose name equals their enclosing namespace (e.g., type
AvalonLog.AvalonLoginside namespaceAvalonLog) are missing from generated API documentation. No one has confirmed whether this was ever fixed or is environment-specific.What This PR Does
Adds a minimal test library
tests/FSharp.ApiDocs.Tests/files/SameNameLib/with:namespace SameNameLibandtype SameNameLib(value: string)netstandard2.1(matching other test libraries)Adds a regression test
ApiDocs includes type whose name matches its namespace (issue 944)that:SameNameLib.dllthroughApiDocs.GenerateModelSameNameLibnamespace is presentSameNameLibtype is present within that namespaceFindings
The test passes on the current codebase — meaning the bug reported in #944 is not present in the current version of FSharp.Formatting. This could mean:
Either way, the test now serves as a regression guard: if a future change accidentally breaks same-name entity handling, CI will catch it.
Test Status
dotnet build FSharp.Formatting.sln --configuration Release— succeeded (0 errors, 1 pre-existing FS0760 warning)dotnet fantomas tests/FSharp.ApiDocs.Tests/ApiDocsTests.fs— applied, no further changes neededFiles Changed
tests/FSharp.ApiDocs.Tests/files/SameNameLib/SameNameLib.fsprojtests/FSharp.ApiDocs.Tests/files/SameNameLib/Library.fstype SameNameLibinsidenamespace SameNameLibtests/FSharp.ApiDocs.Tests/FSharp.ApiDocs.Tests.fsprojProjectReferenceto SameNameLibFSharp.Formatting.slntests/FSharp.ApiDocs.Tests/ApiDocsTests.fsRELEASE_NOTES.md[Unreleased]