Skip to content

API review v1.0.1: modernize public API#31

Merged
kdw503 merged 1 commit into
masterfrom
dwk/mng
May 18, 2026
Merged

API review v1.0.1: modernize public API#31
kdw503 merged 1 commit into
masterfrom
dwk/mng

Conversation

@kdw503
Copy link
Copy Markdown
Member

@kdw503 kdw503 commented May 18, 2026

Summary

  • T1-1 set_FFTPROD was exported but undefined against RegisterMismatchCommon ≥ 1.0.2; now resolves correctly; FFTPROD ref also exported directly
  • T1-2 Renamed allow_inner_threading!set_inner_threading! (old name implied a one-way permission grant rather than a toggle); deprecation shim keeps existing callers working
  • T2-1 mismatch_zeroshift and checksamesize now explicitly exported so callers who act on deprecation warnings find the replacement in scope
  • T2-2 Non-mutating correctbias and truncatenoise now explicitly exported alongside their ! variants
  • T2-3 set_inner_threading! and inner_threading now exported
  • T2-4 CMStorage{T}(undef, width, shift) now accepts AbstractVector for both arguments, consistent with the DimsLike/WidthLike convention used in the high-level API
  • T2-5 highpass! imported from RegisterCore and exported alongside highpass
  • T2-6 FFTPROD ref exported directly
  • T3-2/T3-4 Internal calls updated to new names (checksizemaxshift, each_aperture_center)
  • Tests updated to new names; test run is now deprecation-warning-free
  • Pins RegisterMismatchCommon ≥ 1.0.3 (which adds set_FFTPROD, each_aperture_center, checksizemaxshift)

All changes are non-breaking — deprecated names remain functional via Base.@deprecate shims.

Test plan

  • Pkg.test("RegisterMismatch") passes (203 tests, zero deprecation warnings)
  • Verify CI green on this PR

🤖 Generated with Claude Code

…ommon 1.0.3

Breaking-free modernization via deprecation shims throughout:

- T1-1: define and call set_FFTPROD (was exported but undefined against dev
  RegisterMismatchCommon 1.0.2+); also export FFTPROD ref directly (T2-6)
- T1-2: rename allow_inner_threading! → set_inner_threading!; name implied
  one-way permission grant rather than a toggle (deprecation shim added)
- T2-1: export mismatch_zeroshift and checksamesize so deprecated callers who
  update their code find the replacement in scope
- T2-2: export non-mutating correctbias and truncatenoise alongside the !
  variants (were accessible but not in the explicit export list)
- T2-3: export set_inner_threading! and inner_threading
- T2-4: CMStorage{T}(undef, width, shift) now accepts AbstractVector for both
  arguments, matching the DimsLike/WidthLike convention of the high-level API
- T2-5: import and export highpass! from RegisterCore alongside highpass
- T3-2: internal call updated from checksize_maxshift → checksizemaxshift
- T3-4: internal call updated from each_point → each_aperture_center
- Update tests to use new names (removes deprecation noise from test output)
- Pin RegisterMismatchCommon ≥ 1.0.3

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

codecov Bot commented May 18, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (5405fa1) to head (972fb03).

Additional details and impacted files
@@            Coverage Diff            @@
##            master       #31   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines          118       123    +5     
=========================================
+ Hits           118       123    +5     

☔ 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 08d6a24 into master May 18, 2026
4 of 5 checks passed
@kdw503 kdw503 deleted the dwk/mng branch May 18, 2026 19:30
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