Skip to content

Package maintenance: Aqua, ExplicitImports, coverage, docstrings, docs#29

Open
kdw503 wants to merge 9 commits into
masterfrom
dwk/mng
Open

Package maintenance: Aqua, ExplicitImports, coverage, docstrings, docs#29
kdw503 wants to merge 9 commits into
masterfrom
dwk/mng

Conversation

@kdw503
Copy link
Copy Markdown
Member

@kdw503 kdw503 commented May 12, 2026

Summary

A full /freshen-package pass covering all maintenance steps:

  • Aqua.jl: added quality checks; fixed compat entries and isnan piracy
  • Remove deprecations: cleaned up deprecated CMStorage constructors
  • ExplicitImports.jl: converted all implicit imports to explicit; added to test suite
  • Limit struct mutability: marked all NanCorrFFTs and CMStorage fields const
  • Test coverage: fixed highpass export, added copy(CMStorage), reached 100% coverage
  • Docstrings: added/improved docstrings for all exported symbols; added Documenter doctest coverage
  • README + docs/: added README with badges and quick-start example; created full Documenter.jl docs/ with concept overview, 7 verified jldoctests, and complete API reference; added docs CI job with julia-docdeploy

Test plan

  • CI passes on both min and 1 Julia versions
  • Docs job builds and deploys to gh-pages (requires DOCUMENTER_KEY secret in repo settings)
  • Coverage report uploads to Codecov

🤖 Generated with Claude Code

kdw503 and others added 9 commits May 8, 2026 14:44
- Add Aqua as test dependency with all-pass checks (piracy broken=true
  for mismatch/mismatch_apertures, which intentionally extend
  RegisterMismatchCommon)
- Add missing compat entries: Aqua, CenterIndexedArrays, ImageFiltering,
  Libdl, Printf, Test
- Remove Base.isnan piracy for Array{Complex{T}} (method was unused)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The vector-argument and old-style Type{T} constructors for CMStorage
were replaced by tuple-based constructors in a prior release.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replace bare `using X` statements with explicit `using X: X, name, ...`
forms for all dependencies. Add ExplicitImports as a test dependency
with a regression check via `check_no_implicit_imports`.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
No fields are ever rebound after construction; const makes the
immutability explicit and enables compiler optimizations.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Export highpass (from RegisterCore) which was advertised in the module
  docstring and tested but never actually re-exported
- Add copy(::CMStorage) which deep-copies the internal NanCorrFFTs fields
- Delete dead sumsq_finite function (defined but never called)
- Add tests for invalid normalization error path and copy(CMStorage)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Write docstring for `fillfixed!` (was exported but undocumented)
- Improve `CMStorage`, `mismatch`, `mismatch!`, `mismatch_apertures`,
  and `mismatch_apertures!`: fix signature style (4-space indent,
  imperative mood), add return type annotations, add cross-references,
  and add `jldoctest` examples to the three primary entry points
- Add `Documenter` as a test dependency and wire up `doctest()` in
  `runtests.jl`

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- README.md: badges (CI, coverage, docs), installation note for HolyLabRegistry,
  quick-start example
- docs/: make.jl, Project.toml, src/index.md (concept overview + 7 jldoctests),
  src/api.md (full API reference via @docs blocks)
- CI.yml: add docs job using julia-docdeploy
- makedocs uses modules=[RegisterMismatch, RegisterMismatchCommon, RegisterCore]
  with checkdocs=:exports and remotes=nothing (upstream pkgs have no git history)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (be5bfd3) to head (da8d54a).

Additional details and impacted files
@@             Coverage Diff              @@
##           master       #29       +/-   ##
============================================
+ Coverage   87.02%   100.00%   +12.97%     
============================================
  Files           1         1               
  Lines         131       118       -13     
============================================
+ Hits          114       118        +4     
+ Misses         17         0       -17     

☔ 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.

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