Simplify documentation, examples, and project tooling - #49
Merged
Conversation
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.
Use one README for GitHub and PyPI, retain v1 migration guidance separately, and consolidate duplicated formatting demos into three runnable examples. IPv6 round-trips now preserve the address family, and clear prefixes use explicit boundaries instead of guesses based on ciphertext.
Remove unused FF1 fields and configuration, source the package version from
ffx.__version__, and fix benchmark seeding, warmup counts, and single-configuration selection. Add regression tests and run the retained examples in CI, with coverage reporting on Python 3.12.Validation: 128 tests passed on Python 3.12; mypy, doctests, all three examples, and a benchmark smoke run passed. Source and wheel builds succeeded, with their README content and version metadata verified.