docs: restructure upcoming changelog and add missing PRs#675
Open
docs: restructure upcoming changelog and add missing PRs#675
Conversation
Group the upcoming version block into Features / Performance / Bug Fixes / Breaking Changes / Documentation sections so the headline (piecewise) leads, and add the entries for #589, #595, #601, #614, #619, #635, #656, #671, #672, #674. Tighten the piecewise block to its final state. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
Trim verbose phrasing in the piecewise / variables / model / solvers sections, fold subset-superset sub-bullets into one paragraph, and drop two entries that aren't user-facing for a release notes audience: sphinx-copybutton (doc tooling) and Model.__weakref__ (only relevant to extension authors). Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
#673 removed the slopes-mode (and slopes_align kwarg) from breakpoints(); the align kwarg now lives on the Slopes class. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
SOS reformulation is a model-rewrite/solve-pipeline concern, not a variable attribute. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
- New *Expressions* subsection holds the subset/superset coord harmonization, which was misfiled under *Model*. - CPLEX quality-attribute handling is a fix for crashes on missing attributes, not a new feature — moved to **Bug Fixes**. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
#659 fixes a regression introduced by #614 in the same release cycle — no end user ever saw the broken state, so a standalone bullet overstates the change. Net behavior is captured by extending the add_variables bullet to mention MultiIndex coords. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
Drop implementation details that belong in API docs (numpy-vs-pandas note, JSON encoding for netCDF, "with no auxiliary variables" piecewise detail), merge the two OETC bullets, and trim "Add X. Supports Y." wrappers across most lines. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
Previous wording ("zeros all auxiliaries when off") was true at the
auxiliary level but glossed over the bounded-tuple case where the
output is not automatically pinned to 0. Drop the implication and
defer the detail to the docstring.
Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
Trim references to specific kwargs/attributes the reader doesn't need in the high-level summary: method="auto" parens, align="pieces|leading", deep / include_solution, reformulate_sos="auto", solver_name / **solver_options, max_dual_infeasibility example, and the operator-by-operator coord-alignment breakdown. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
FabianHofmann
approved these changes
May 7, 2026
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
2 participants
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.
Summary
Restructures the Upcoming Version block of
doc/release_notes.rstinto a sectioned layout (Features / Performance / Bug Fixes / Breaking Changes) so the headline (piecewise) leads, and folds in 9 PRs that had merged to master since v0.6.7 but weren't yet in the changelog.The previous flat list of 20 bullets buried the major piecewise work and mixed one-line fixes with multi-paragraph features.
What changed
Layout — feature subsections by domain:
Newly captured PRs — #589, #595, #601, #614, #619, #635, #671, #672, #674.
Cuts —
sphinx-copybutton(doc tooling) and__weakref__onModel(only relevant to extension authors) removed as not user-facing.Tightening — piecewise opening bullet trimmed (the
EvolvingAPIWarningrationale +warnings.filterwarningssnippet belong in API docs);slopes_alignmoved frombreakpoints()toSlopes.alignto reflect the post-#673 final state; theas_dataarrayMultiIndex fix (#659) folded into theadd_variablesbullet since #659 fixed a regression introduced by #614 in the same release cycle.Reclassifications — CPLEX quality-attribute handling moved from Solvers to Bug Fixes (it's a fix, not a feature); SOS reformulation moved from Variables to Model (it's a solve-pipeline concern).
Test plan
doc/release_notes.rstlocally and confirm the Upcoming section reads cleanly.🤖 Generated with Claude Code