docs(docxdiff): PreserveInputRevisions models Word's Combine, not Compare (#867) [stack 1/9] - #912
Merged
Merged
Conversation
This was referenced Oct 4, 2026
Closed
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.
Why
Issue #867 reported that CLAUDE.md said the
DocxComparefront door both pre-accepts and preserves input revisions, while the code only pre-accepts. The code is the intended behaviour. The decision was made and recorded in #845 (PR #886), which also fixed CLAUDE.md and theDocxComparecomments.The same wrong claim was still in other places. It said that keeping each input's own tracked changes (
PreserveInputRevisions) is "Word Compare's own behavior", and those places are what a caller actually reads:DocxDiffSettings.PreserveInputRevisions(in IntelliSense);revisionsInInputnote in theDocxDiffCompatibilitycatalog, which the API returns at runtime;types.ts) and Python (types.py) docstrings ("Word-style");ir_diff_engine.mdand two sections ofooxml_corner_cases.md. One of those labelled preservation the Docxodus default, which it is not.What changed
Wording only. Each place now says that preserving input revisions is what Word's Combine does. Word's Compare treats them as accepted, which is what
PreAcceptInputRevisionsand theDocxComparefront door do. No behaviour, setting, or default changes. Historical CHANGELOG entries are left as written; a later entry already notes the policy change.Validation
dotnet build Docxodus/Docxodus.csproj: clean.DocxCompareTests.FrontDoorPolicy_*asserts the front door leavesPreserveInputRevisionsfalse.DocxCompareOriginalPendingRevisionsTestspins the output.grepfor "Word-style", "Word-parity" and "Word's Compare" near preserve wording across the core, the bridges, the clients and the docs finds no remaining claim.Adversarial review
One adversarial pass over the diff. It found the catalog note in
DocxDiffCompatibility.cs, which is runtime-visible and repeated the claim; it is now fixed. It also checked that the old corner-cases heading isn't linked from anywhere before renaming it.Closes #867
🤖 Generated with Claude Code