Skip to content

API review v1.0.2: modernize public API#23

Merged
kdw503 merged 2 commits into
masterfrom
dwk/mng
May 18, 2026
Merged

API review v1.0.2: modernize public API#23
kdw503 merged 2 commits into
masterfrom
dwk/mng

Conversation

@kdw503
Copy link
Copy Markdown
Member

@kdw503 kdw503 commented May 18, 2026

Summary

  • Breaking (accepted at patch per package policy — controlled downstream):

    • register_translate: positional thresh removed; use thresh=… keyword
    • assertsamesizechecksamesize (@deprecate shim kept for one-release migration)
    • mismatch0mismatch_zeroshift (@deprecate shim kept)
    • set_FFTPROD(v) removed; mutate via RegisterMismatchCommon.FFTPROD[] = v directly (const FFTPROD = Ref([2,3]) is now exported)
  • Non-breaking additions:

    • Export mismatch_apertures
    • mismatch / mismatch_apertures forward kwargs… to downstream protocol (no longer hard-coding normalization=:intensity)
    • Non-mutating correctbias and truncatenoise companions (follow Base f / f! convention)

Test plan

  • CI passes (322 tests, 0 ambiguities)
  • Merge commit — register v1.0.2 via JuliaRegistrator on the merge commit

🤖 Generated with Claude Code

kdw503 and others added 2 commits May 18, 2026 09:32
Add mismatch_apertures to the public export list. It was already defined
at module scope as the aperture-wise counterpart to mismatch, but callers
needed qualified access (RegisterMismatchCommon.mismatch_apertures) to use it.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Breaking changes (accepted at patch per package policy):
- register_translate: positional `thresh` removed; use `thresh=…` keyword
- assertsamesize renamed to checksamesize (@deprecate shim kept)
- mismatch0 renamed to mismatch_zeroshift (@deprecate shim kept)
- set_FFTPROD removed; use const FFTPROD = Ref([2,3]) directly

Non-breaking additions:
- Export mismatch_apertures
- mismatch/mismatch_apertures forward kwargs… to downstream protocol
- Add non-mutating correctbias and truncatenoise companions
- Export FFTPROD (Ref-based mutable config)

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@codecov
Copy link
Copy Markdown

codecov Bot commented May 18, 2026

Codecov Report

❌ Patch coverage is 92.30769% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 90.49%. Comparing base (bc5bbab) to head (90bc306).

Files with missing lines Patch % Lines
src/RegisterMismatchCommon.jl 92.30% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master      #23      +/-   ##
==========================================
+ Coverage   87.44%   90.49%   +3.04%     
==========================================
  Files           1        1              
  Lines         239      242       +3     
==========================================
+ Hits          209      219      +10     
+ Misses         30       23       -7     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@kdw503 kdw503 merged commit 6e8629b into master May 18, 2026
4 checks passed
@kdw503 kdw503 deleted the dwk/mng branch May 18, 2026 16:09
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