Repository navigation
refactor!: retire the markdown sidecar for XML documentation - #41
Merged
StevenTCramer merged 5 commits intoNov 8, 2026
Merged
StevenTCramer merged 5 commits into
StevenTCramer merged 5 commits into
Conversation
XML documentation stays in the C# file. The analyzer that asked to move those comments out, and the generator that turned a sibling markdown file into XML docs, are gone. The package still ships the file-name and global usings analyzers. why: task 032, Steve 2026-11-09 Co-Authored-By: grok <noreply@x.ai>
TW0001 is an incremental generator that only reports diagnostics, so the overviews cannot claim the package ships no source generator. The retired TW0002 and TW0003 ids are named so a later rule does not reuse them. The partial-property note is about nullable analysis, not definite assignment. why: task 032 review round 1 Co-Authored-By: grok <noreply@x.ai>
StevenTCramer
deleted the
task/032-remove-xml-docs-to-markdown-analyzer-and-generator
branch
November 8, 2026 18:31
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.
Summary
XML documentation stays in the C# file. The TW0002 analyzer, both TW0003 generator files, the code-fix setup doc, the XMLDoc template pages, and the markdown-only test fixtures are deleted. Release tracking lists TW0001 and TW0007. Those retired ids are not reused. Package tags are
TimeWarp; Analyzers. The packed nuspec tags areTimeWarp Analyzers. The package id is stillTimeWarp.SourceGenerators.Task 016 was already archived on origin-home (
5e02ad4). Its draft stays underkanban/archived/016-create-xml-docs-to-markdown-code-fix/and is not part of a project. Task 013 was archived from origin-home withganda kanban archive 013and landed as6d2a467. This branch does not edit that file.kanban/done/**was not edited.KebabCaseTest.GetTestMessageandPascalCaseTest.GetPascalMessagewere implementing partials whose other half came from the generator. They are ordinary methods so the TW0001 console smoke still compiles. The test console no longer passes markdown in as additional files../bin/dev buildsucceeded with 0 warnings and 0 errors and packedartifacts/packages/TimeWarp.SourceGenerators.1.0.0-beta.11.nupkg../bin/dev testprinted the four console lines and reported Passed 11, Failed 0.ganda repo auditthen passed 36, failed 0, skipped 3.--fixwrote the local ignored VS Code window title. The post-fix dev-cli self-install failed with the knownMSB3030missingdev.xml../bin/dev --versionstill runs.Spikes under
spikes/partial-properties-csharp13/still describe the old generator. They are not live docs and were left in place.The review fix pass corrects three doc issues. The four overview pages now use the same wording: the package generates no source, TW0001 runs as an incremental generator that only reports diagnostics, and TW0007 is a diagnostic analyzer.
documentation/developer/conceptual/analyzer-release-tracking.mdrecords that TW0002 and TW0003 were removed unshipped in task 032 and must not be reused.AnalyzerReleases.Unshipped.mdis still only the live-rule table. The partial-property note saysfield ?? ""keeps the getter from returning null, so nullable analysis does not warn (CS8618).After that wording change, the stale-phrase search printed nothing. The shared sentence is in all four overview pages. TW0002 and TW0003 appear only on the Retired ids line.
./bin/dev buildsucceeded with 0 warnings and 0 errors../bin/dev testprinted the four console lines and reported Passed 11, Failed 0.ganda repo auditpassed 36, failed 0, skipped 3.Test plan
rg -n "does not ship a source generator|satisfies definite assignment" documentation Kanban task 032 Session: Grok 01a1bc51-a208-7a53-a024-65c8ebeb9160