Skip to content

WIP: Deduplicate FSharp.Core XML docs via <include> - #20231

Open
T-Gro wants to merge 1 commit into
mainfrom
t-gro-fsharpcore-xmldoc-include-dedup
Open

WIP: Deduplicate FSharp.Core XML docs via <include>#20231
T-Gro wants to merge 1 commit into
mainfrom
t-gro-fsharpcore-xmldoc-include-dedup

Conversation

@T-Gro

@T-Gro T-Gro commented Aug 7, 2026

Copy link
Copy Markdown
Member

Follow-up to #19186 (FS-1341): first in-repo use of the compile-time <include> tag inside FSharp.Core.

Moves 8 repeated /// doc blocks (36 call sites) into shared fragments under src/FSharp.Core/xmldoc/ and replaces each occurrence with a one-line <include>:

  • sort stability/complexity remark — array (12), list (5), seq (5)
  • Parallel.For remark — array (5 identical sites; the genuinely different ones are left alone)
  • dynamic-implementation summaries — resumable (5), tasks (4)

Layout: per-topic files (sort.xml, parallel.xml, dynamic.xml) with element-name keys; callsite reads path="/sort/arrayUnstable/*".

Generated FSharp.Core.xml is unchanged apart from insignificant whitespace — verified canonically identical to the pre-change baseline. No documentation wording changes.

WIP: draft while CI is validated.

@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

⚠️ Release notes required, but author opted out

Warning

Author opted out of release notes, check is disabled for this pull request.
cc @dotnet/fsharp-team-msft

T-Gro added a commit that referenced this pull request Aug 7, 2026
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@T-Gro
T-Gro force-pushed the t-gro-fsharpcore-xmldoc-include-dedup branch from bfddcc7 to 2ad440d Compare August 7, 2026 11:51
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@T-Gro
T-Gro force-pushed the t-gro-fsharpcore-xmldoc-include-dedup branch from 2ad440d to adff9a8 Compare August 7, 2026 12:07
@T-Gro T-Gro added the NO_RELEASE_NOTES Label for pull requests which signals, that user opted-out of providing release notes label Aug 7, 2026
@T-Gro
T-Gro requested a review from abonie August 7, 2026 12:07
@T-Gro
T-Gro marked this pull request as ready for review August 7, 2026 12:07
@T-Gro
T-Gro requested a review from a team as a code owner August 7, 2026 12:07
@github-actions github-actions Bot added the AI-Tooling-Check-Bypassed Tooling check: non-fork PR, not diff-analyzed label Aug 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI-Tooling-Check-Bypassed Tooling check: non-fork PR, not diff-analyzed NO_RELEASE_NOTES Label for pull requests which signals, that user opted-out of providing release notes

Projects

Status: New

Development

Successfully merging this pull request may close these issues.

1 participant