Skip to content

Package maintenance: quality checks, coverage, docstrings, and docs#57

Merged
kdw503 merged 8 commits into
masterfrom
dwk/mng
May 27, 2026
Merged

Package maintenance: quality checks, coverage, docstrings, and docs#57
kdw503 merged 8 commits into
masterfrom
dwk/mng

Conversation

@kdw503
Copy link
Copy Markdown
Member

@kdw503 kdw503 commented May 27, 2026

Summary

  • Aqua.jl: added quality checks to the test suite
  • ExplicitImports.jl: replaced wildcard imports with explicit using declarations
  • Struct mutability: audited mutable struct fields; marked const where appropriate
  • Test coverage: expanded tests to reach 100% coverage
  • Docstrings: added and improved docstrings for all exported symbols; added jldoctest examples verified in CI
  • Documentation: set up Documenter.jl docs/ with a user guide, API reference, and GitHub Pages deployment via Documenter.yml; updated README with installation instructions, a quick-start example, and stable/dev doc badges
  • Misc: updated .gitignore, formatted with Runic, removed deprecations

Test plan

  • CI passes (tests + doctests)
  • Documenter workflow builds and deploys to GitHub Pages (requires DOCUMENTER_KEY secret to be set in repo settings)

🤖 Generated with Claude Code

kdw503 and others added 8 commits May 27, 2026 09:49
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- grid_rotations: even rgridsz warning/correction, 1D error path
- qd_translate: crop=true with undersized moving image
- warp_and_intersect: IdentityTransformation with mismatched axes

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add module-level docstring to RegisterQD with entry-point overview
  and backend requirement note
- Rewrite all public function docstrings: 4-space-indented signatures,
  imperative mood, correct thresh defaults, fix copy-paste errors
  (stray mxrot in qd_affine, wrong function name in qd_translate),
  remove duplicate kwargs paragraph in qd_affine
- Add # Examples blocks to all eight exported functions; jldoctest
  blocks for pure-computation functions, julia-repl for registration
  functions that require a backend
- Replace outdated getSD example (ImageMeta/N2f14 era) with current
  AxisArrays-based example
- Add Documenter to test extras/targets and wire up doctest in runtests.jl

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ctest

- Set up docs/ with index, user guide, and API reference pages; add
  Documenter.yml CI workflow for GitHub Pages deployment
- Update README with installation instructions, quick-start example,
  and stable/dev documentation badges
- Convert three julia-repl doctest blocks (qd_rigid, qd_affine,
  rotation_gridsearch) to jldoctest so they are verified in CI;
  fix missing ImageFiltering import in rotation_gridsearch example

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…l to .gitignore

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
OffsetArrays 0.11.x exports `axes`, creating an ambiguity with Base.axes
that makes the bare name inaccessible. Use Base.axes explicitly.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Same OffsetArrays 0.11.x ambiguity fix applied consistently to all test files.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@kdw503 kdw503 merged commit 0dcf59c into master May 27, 2026
6 checks passed
@kdw503 kdw503 deleted the dwk/mng branch May 27, 2026 18:40
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