docs: make the README quickstart executable and accurate - #93
Open
mazzasaverio wants to merge 1 commit into
Open
mazzasaverio wants to merge 1 commit into
mazzasaverio wants to merge 1 commit into
Conversation
mazzasaverio
marked this pull request as ready for review
October 2, 2026 06:33
This branch has not been deployed
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.
The first README quickstart failed because it expected <EMAIL_1> while the package emits <EML_1>. Align aliases and execute all Python examples in an integration test, providing the file example's input in a temporary directory. Also label the historical benchmark as overlap scoring and document the heuristic streaming boundary limitation. Library behavior and token formats do not change.
Validation: 11 focused README/stream/session tests passed. Full CI passed 525 tests per matrix job with 95.00% to 95.06% coverage, plus quality, docs, performance, property, packaging and installed-wheel checks: https://github.com/ma2za/pseudonymize/actions/runs/36972876550 . The README async function is compiled by the new test; existing integration tests exercise asynchronous streaming.