Skip to content

Clarify positional comparisons in diff documentation - #644

Open
zanmlakar wants to merge 1 commit into
pytoolz:masterfrom
zanmlakar:docs/clarify-diff-positional-comparison
Open

zanmlakar wants to merge 1 commit into
pytoolz:masterfrom
zanmlakar:docs/clarify-diff-positional-comparison

Conversation

@zanmlakar

Copy link
Copy Markdown

The diff docstring does not explicitly explain that it compares items at the same position. Describe the tuples it yields and the default stop-at-shortest behavior, and add a runnable example comparing aligned monthly sales counts across two years. The example uses the same values in different positions to make the distinction clear.

Fixes #459.

Validation: existing focused unit tests and doctests (85 passed, 1 skipped), full toolz tests and doctests (269 passed, 1 skipped), benchmarks (19 passed), pycodestyle, changed-file pre-commit hooks, and Sphinx HTML build. No runtime behavior changes.

AI disclosure: This documentation change was prepared with OpenAI Codex (gpt-6.1-sol) and independently reviewed by another Codex agent. No human code review or sign-off is claimed.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

diff doc is unclear

1 participant