Update quickstart to feature DocxodusEngine; widen run_redline type hint#23
Merged
Conversation
…ype hint The quickstart guide led with the legacy XmlPowerToolsEngine, contradicting the main README's recommendation. Rewrite it around DocxodusEngine, install the [docxodus] extra, and call out that the legacy engine silently ignores the kwargs (move detection, detail threshold, etc.) that the new Step 4 demonstrates. Also widen run_redline's path arguments from Union[bytes, Path] to Union[str, bytes, Path] to match documented usage — both quickstart examples pass plain strings, which work but did not match the annotation. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.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
1 participant
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
docs/quickstart.mdled with the legacyXmlPowerToolsEngineand installed[ooxmlpowertools], contradicting the main README which recommends Docxodus. Rewrite aroundDocxodusEngineand the[docxodus]extra.DocxodusEnginekwargs (detect_moves,simplify_move_markup,detail_threshold) and explicitly note thatXmlPowerToolsEnginesilently ignores them.run_redline'soriginal/modifiedannotation fromUnion[bytes, Path]toUnion[str, bytes, Path]— both quickstart examples pass plainstrpaths, which work but did not match the type hint.These were spotted while walking the README end-to-end on a fresh clone; everything else in the README and dev workflow was verified accurate.
Test plan
python -m pytest tests/— 21/21 passed locally with the type-hint change#comparison-settings-docxodusengine-onlyanchor resolves)🤖 Generated with Claude Code