Skip to content

Add release notes for everything since 1.6.1 - #45

Draft
Jim Garrison (garrison) wants to merge 1 commit into
sphinx-docsfrom
release-notes-1.7.0
Draft

Jim Garrison (garrison) wants to merge 1 commit into
sphinx-docsfrom
release-notes-1.7.0

Conversation

@garrison

Copy link
Copy Markdown
Member

#43 adds the reno machinery but deliberately ships no notes, so the release-notes page it builds renders empty. Twenty-eight commits have landed since the 1.6.1 tag, several of which change behavior a user has to know about, and none of it is written down anywhere a user will look. This backfills that history as 19 notes: 6 upgrade, 7 features, 6 fixes.

The 1.6.1 tag is far behind main, so every commit covered here is unreleased. The notes render under "Upcoming release" until 1.7.0 is tagged, at which point reno attaches them to it — so this needs no coordination with the version bump in #42, and the notes are filed loose in releasenotes/notes/ rather than in a 1.7.0/ subdirectory.

The upgrade notes are the point of the exercise

Scope

Examples get one combined note rather than one per pull request: they are scripts in the repository, not importable API. It records the parameter regrouping, the dropped Hartree-Fock seed and the new enlarge-subspace driver without itemizing seven pull requests. CI and documentation-only changes get no notes.

Three changes are deliberately omitted as invisible to a 1.6.1 user: the importlib.metadata version switch (#16), the vendored upstream bump (#24 — the makestring template instantiation preserves the exposed signature), and the internal GPU build-flag cleanups (#17, #25).

Verification

sphinx-build -W --keep-going, the same command tox -e docs runs, succeeds with zero warnings. All 19 notes render under the correct New Features / Upgrade Notes / Bug Fixes headings, and all 22 :func: cross-references resolve to real anchors — 22 roles, 22 links, so none failed silently. reno lint passes.


This pull request was generated by Claude Opus 5 under my guidance.

PR #43 adds the reno machinery but deliberately ships no notes, so the
release-notes page renders empty. Twenty-eight commits have landed since the
1.6.1 tag, several of which change behavior a user has to know about, and none
of it is written down anywhere a user will look.

Backfill that history as 19 notes: 6 upgrade, 7 features, 6 fixes. The 1.6.1
tag is far behind main, so every commit covered here is unreleased and the
notes render under "Upcoming release" until 1.7.0 is tagged; they need no
coordination with the version bump in #42.

The upgrade notes are the point of the exercise. Multi-iteration SQD results
move, because the amplitudes handed back to the SQD loop were being replaced by
a uniform array and are now correct. h_comm_size is gone from the config
objects, which raises AttributeError on assignment and, less obviously, is
silently ignored as an sbd_config key. carryover_type now defaults to 0,
SBD_BUILD_BACKEND=both is rejected in favor of all, backends load one per
process with OMP_TARGET_OFFLOAD defaulted to MANDATORY, and pybind11 is no
longer a runtime dependency.

Examples get one combined note rather than one per pull request: they are
scripts in the repository, not importable API, so the note records the
parameter regrouping, the dropped Hartree-Fock seed and the new
enlarge-subspace driver without itemizing seven pull requests.

CI and documentation-only changes get no notes. Three further changes are
deliberately omitted as invisible to a 1.6.1 user: the importlib.metadata
version switch, the vendored upstream bump (the makestring template
instantiation preserves the exposed signature), and the internal GPU
build-flag cleanups.

Assisted-by: Claude Opus 5

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.

1 participant