Repository navigation
docs: clarify release capabilities and assert invoice outcomes - #15
Merged
Merged
Conversation
dev-belly
marked this pull request as ready for review
October 15, 2026 02:01
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.
A visitor downloading v0.1.0 cannot use all examples and commands described in the current README. Clarify in English and Chinese that the quick start clones main, while the older release predates the optional CSV example and benchmark command; link the release and comparison.
The invoice example previously checked only agreement between SQL and the Python oracle. Add a separate fixed check for the three documented decisions: missing before arrival, invoice-v1 at 100,000 after the original arrives, and invoice-v2 at 135,000 after the correction arrives. Preserve full JSON output and existing oracle comparison.
Validation: Python 3.12.14, 94 existing unittest cases passed with no skips, including pandas and full output equivalence between examples. The invoice script produced its documented output. A separate failure check made both engines return the same incorrect February correction, and the new expectation check rejected it. The three changed files are UTF-8 without BOM and use LF endings. No runtime selection rules, release tags, package versions or saved evidence changed.