Conversation
Several files carried commented-out code left over from earlier refactors, with no accompanying TODO or explanation and no live callers referencing the names: - GenerateHtml.fs: an unused `obsoleteMessage` helper. - SymbolReader.fs: four unused `signatureTooltip` computations and one stray `if isUnitType ...` comment, none of which are read anywhere. - CodeFormatAgent.fs: an alternate, unused `ProjectOptions` construction plus stale debug-logging comments. - HtmlModel.fs: an unused `string` alias shadowed by `(!!)` on the next line. Removing these has no behavioral effect; it just reduces noise for future readers. Left the various genuinely-explanatory TODO comments (e.g. XmlDocReader's exceptions/parameters section) untouched, since those document real future work rather than abandoned code. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Collaborator
|
/repo-assist there is no need for a changelog entry for this since this is not user facing |
Contributor
Author
|
✓ Repo Assist completed successfully, see workflow run.
|
Per maintainer feedback (nojaf), this refactor has no user-facing impact, so it does not need a RELEASE_NOTES.md entry. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
nojaf
marked this pull request as ready for review
September 25, 2026 06:49
nojaf
deleted the
repo-assist/improve-remove-dead-comments-20260925-350ac22476875752
branch
September 25, 2026 06:49
github-actions Bot
added a commit
that referenced
this pull request
Sep 27, 2026
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
github-actions Bot
added a commit
that referenced
this pull request
Sep 27, 2026
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
github-actions Bot
added a commit
that referenced
this pull request
Sep 27, 2026
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
github-actions Bot
added a commit
that referenced
this pull request
Sep 27, 2026
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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 PR was created by Repo Assist, an automated AI assistant for this repository.
Summary
Removed several blocks of long-dead commented-out code that had accumulated from earlier refactors, with no live callers and no explanatory TODO tying them to future work:
GenerateHtml.fs: an unusedobsoleteMessagehelper (never called; no reference anywhere in the file).SymbolReader.fs: four unusedsignatureTooltipcomputations (one per member kind: function/value, union case, field, static parameter) and one stray(if/redacted) isUnitType retType then None else Some retTypeTextcomment — all superseded by theusageHtml/returnTypecomputed nearby, and none read anywhere.CodeFormatAgent.fs: an alternate, unusedProjectOptionsconstruction plus stale debug-logging comments referencing a code path that no longer exists.HtmlModel.fs: an unusedstringalias immediately shadowed by the(!!)operator on the very next line.Rationale
These fragments add noise without adding information — no TODO, issue reference, or design note explains why they're kept. I deliberately left genuinely-explanatory
TODOcomments alone (e.g. the exceptions/parameters-section TODO inXmlDocReader.fs), since those document real, tracked future work rather than abandoned code.Trade-offs
None — purely a comment/dead-code removal with no behavior change.
Test Status
dotnet build FSharp.Formatting.sln --configuration Release— succeeds, 0 warnings, 0 errors.dotnet test FSharp.Formatting.sln --configuration Release --no-build— full suite passes: 375 (Markdown) + 43 (CodeFormat) + 31 (fsdocs-tool) + 146 (Literate) + 100 (ApiDocs) = 695 passed, 0 failed (6 pre-existing skips unrelated to this change).dotnet fantomas <changed files> --check— no formatting changes needed.Add this agentic workflow to your repo
To install this agentic workflow, run