Skip to content

[repo-assist] refactor: remove long-dead commented-out code - #1347

Merged
nojaf merged 2 commits into
mainfrom
repo-assist/improve-remove-dead-comments-20260925-350ac22476875752
Sep 25, 2026
Merged

nojaf merged 2 commits into
mainfrom
repo-assist/improve-remove-dead-comments-20260925-350ac22476875752

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

🤖 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 unused obsoleteMessage helper (never called; no reference anywhere in the file).
  • SymbolReader.fs: four unused signatureTooltip computations (one per member kind: function/value, union case, field, static parameter) and one stray (if/redacted) isUnitType retType then None else Some retTypeText comment — all superseded by the usageHtml/returnType computed nearby, and none read anywhere.
  • CodeFormatAgent.fs: an alternate, unused ProjectOptions construction plus stale debug-logging comments referencing a code path that no longer exists.
  • HtmlModel.fs: an unused string alias 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 TODO comments alone (e.g. the exceptions/parameters-section TODO in XmlDocReader.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.

Generated by 🌈 Repo Assist, see workflow run. Learn more.
Comment /repo-assist to run again

Add this agentic workflow to your repo

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/repo-assist.md@4bc8419fad05e6b032741cbfd189986700bcf71c

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>
@nojaf

nojaf commented Sep 25, 2026

Copy link
Copy Markdown
Collaborator

/repo-assist there is no need for a changelog entry for this since this is not user facing

@github-actions

github-actions Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor Author

✓ Repo Assist completed successfully, see workflow run.

Generated by 🌈 Repo Assist, see workflow run. Learn more.

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
nojaf marked this pull request as ready for review September 25, 2026 06:49
@nojaf
nojaf merged commit aa9c4f7 into main Sep 25, 2026
2 checks passed
@nojaf
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant