Skip to content

Fix docs build errors introduced by 1.0.1 API review #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kdw503 merged 2 commits into from
May 18, 2026
Merged

Fix docs build errors introduced by 1.0.1 API review #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5cf3bb
Fix docs build: add missing exported symbols, drop deprecated-only al…
kdw503 May 18, 2026
9991afe
Replace deprecated mismatch0 with mismatch_zeroshift in index.md doctest
kdw503 May 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions docs/src/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ mismatch
mismatch!
mismatch_apertures
mismatch_apertures!
mismatch0
mismatch_zeroshift
```

## Low-level reusable workflow
Expand All @@ -41,7 +41,9 @@ nanpad

```@docs
correctbias!
correctbias
truncatenoise!
truncatenoise
```

## Utilities
Expand All @@ -51,8 +53,11 @@ register_translate
aperture_grid
allocate_mmarrays
aperture_range
each_point
each_aperture_center
FFTPROD
set_FFTPROD
inner_threading
set_inner_threading!
```

## Types and helpers (RegisterCore)
Expand Down Expand Up @@ -91,8 +96,8 @@ WidthLike
## Internal helpers

```@docs
assertsamesize
checksize_maxshift
checksamesize
checksizemaxshift
default_aperture_width
padranges
padsize
Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ is below a noise threshold.
```jldoctest
julia> mm = mismatch([1.0 2.0; 3.0 4.0], [1.0 2.0; 3.0 4.0], (1, 1));

julia> nd = mismatch0([1.0 2.0; 3.0 4.0], [1.0 2.0; 3.0 4.0])
julia> nd = mismatch_zeroshift([1.0 2.0; 3.0 4.0], [1.0 2.0; 3.0 4.0])
NumDenom(0.0,60.0)
```

Expand Down
Loading