chore(release): 5.6.0 - #117
Merged
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
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.
Cuts 5.6.0. MINOR — the release is entirely fixes plus one new internal module (
scpi_control.units), with one new optional parameter. Nothing broke: no renames, no removed names, no required-parameter changes.Contents
Six
### Fixedentries, from PR #115 (five) and PR #116 (one).Three silent failures in the automation capture path (#115) — all from the 2026-07-22 adversarial audit, all re-verified against
mainbefore any code was written:save_waveformrejectednpzandh5, two of the four format names its own docstrings list — one of themstart_continuous_capture's default. An overnight run with default arguments wrote nothing, and four shipped examples were broken the same way. The same spellings were already valid as file extensions via auto-detect, which is what produced the inconsistency.batch_captureraisedTypeErroron the SI-string scales its own docstring documents and its example copies verbatim, discarding every capture already taken. Now parsed by the newscpi_control/units.py.capture_singleslept a flat 0.5 s instead of pollingacquisition_status(), so on a slow timebase it returned the previous acquisition — whichbatch_capturethen recorded under the new config's label. Wrong data, correctly formatted, no warning.Plus two changes that came out of reviewing those:
capture_singleno longer clobbers a user-configuredNORMtrigger mode (disclosed in its docstring, not buried), andparse_si_valuescales by shifting the decimal exponent so'10us'is exactly1e-05rather than reaching the instrument asTDIV 9.999999999999999e-06.One documentation fix (#116) — the README screenshot used a repository-relative path, so it silently failed to load on PyPI while rendering fine on GitHub. Now an absolute raw URL, matching what the README's other six images already did.
Release mechanics
pyproject.tomlandscpi_control/__init__.pybumped 5.5.0 → 5.6.0 (both hand-maintained;tests/test_version_consistency.pyenforces they agree)## [5.6.0] - 2026-07-26header inserted under## [Unreleased]docs/about/changelog.mdre-synced toCHANGELOG.md— byte-identical hand-maintained mirrors that nothing in the suite enforces, so this is a manual step every releaseVerification
black --check --line-length 200 scpi_control/ examples/clean (180 files);flake8 --select=E9,F63,F7,F82= 0Note
The README screenshot fix takes effect on this release's PyPI page. The 5.5.0 page keeps the broken image — PyPI project pages are immutable per release.
After merge: tag
v5.6.0and publish the GitHub release, which triggers the build/PyPI/docs workflow.