docs(v1): describe join=None default without headlining "exact"#832
Merged
Merged
Conversation
The default join follows options["semantics"]. Describe v1 directly — shared dims must carry the same label set, a pure reorder aligns by label, a differing set raises — rather than calling it "exact", which overstates it (v1 is order-independent; a reorder does not raise on #717, only a differing label set does). Applied to both the Variable and expression methods so their docstrings stay in parity. Co-Authored-By: Claude Opus 4.8 (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.
Stacked on #717. Docs-only: clarifies what the
join=Nonedefault means so users can reason about alignment without reading the source.Note
The following was generated by AI.
The public
joindocstrings (Variable/LinearExpression.add/.sub/.mul/.div/.le/.ge/.eq, plus the internal_align_constanthelper) previously said either the vague "current default behavior" (variables.py) or headlined"exact" under v1(expressions.py). The two files had drifted, and "exact" overstates it: under v1 on #717 a pure reorder does not raise — it aligns by label; only a differing label set raises.Every public docstring now reads consistently:
No behavior change. When the exact-alignment work (#831) tightens §8, this wording flips in one place: "a pure reorder aligns by label" → "raises".