Skip to content

Fix docs build errors introduced by 1.0.1 API review#32

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

Fix docs build errors introduced by 1.0.1 API review#32
kdw503 merged 2 commits into
masterfrom
dwk/mng

Conversation

@kdw503
Copy link
Copy Markdown
Member

@kdw503 kdw503 commented May 18, 2026

Summary

  • api.md: add 9 exported symbols that gained docstrings in RegisterMismatchCommon 1.0.3 (mismatch_zeroshift, correctbias, truncatenoise, checksamesize, checksizemaxshift, each_aperture_center, FFTPROD, inner_threading, set_inner_threading!); remove 4 @deprecate-only aliases that have no Documenter docstrings (mismatch0, each_point, assertsamesize, checksize_maxshift).
  • index.md: replace deprecated mismatch0 with mismatch_zeroshift in the Post-processing doctest.

Test plan

  • Docs CI passes (no :cross_references, :missing_docs, or :docs_block errors)
  • All existing tests still pass

🤖 Generated with Claude Code

kdw503 and others added 2 commits May 18, 2026 14:39
…iases

The API review upgraded to RegisterMismatchCommon 1.0.3, which renamed
several symbols (assertsamesize→checksamesize, checksize_maxshift→
checksizemaxshift, each_point→each_aperture_center, mismatch0→
mismatch_zeroshift) and added non-mutating variants (correctbias,
truncatenoise) plus new exports (FFTPROD, inner_threading,
set_inner_threading!). The old names are now @deprecate aliases with no
Documenter docstrings. Update api.md to match.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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 (08d6a24) to head (9991afe).

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

☔ 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 3af2906 into master May 18, 2026
5 checks passed
@kdw503 kdw503 deleted the dwk/mng branch May 18, 2026 19:52
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