Skip to content

Package maintenance: quality checks, explicit imports, docstrings, README, v1.0.0 - #27

Merged
kdw503 merged 7 commits into
masterfrom
dwk/mng
May 14, 2026
Merged

Package maintenance: quality checks, explicit imports, docstrings, README, v1.0.0#27
kdw503 merged 7 commits into
masterfrom
dwk/mng

Conversation

@kdw503

@kdw503 kdw503 commented May 14, 2026

Copy link
Copy Markdown
Member

Summary

  • Add Aqua.jl quality checks and ExplicitImports.jl to the test suite
  • Make all implicit imports explicit in src/
  • Add docstrings for all public symbols; add Documenter doctests (run in CI)
  • Add README with CI/Codecov badges, installation instructions (HolyLabRegistry), concept explanation, and usage example
  • Bump version to 1.0.0

Test plan

  • CI passes on min and 1 Julia versions
  • Doctests pass (doctest(RegisterHindsight))
  • Aqua and ExplicitImports checks pass
  • README renders correctly on GitHub

🤖 Generated with Claude Code

kdw503 and others added 7 commits May 14, 2026 11:36
RegisterMismatch was in [deps] but never imported in src/ — moved to
[extras]. Added compat entries for all test extras (Aqua, ForwardDiff,
ImageMagick, Random, RegisterCore, RegisterMismatch, Test, TestImages).
All Aqua checks pass.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ations v0.16+

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Module docstring for RegisterHindsight explaining purpose and entry points
- InterpolatingDeformation: documents ScaledInterpolation constraint and
  InPlace BC requirement (previously a hidden runtime error)
- All penalty_hindsight* functions: new docstrings covering both single-ϕ
  and dual-ϕ overloads, gradient (!) variants, and equal-footing semantics
- optimize!: corrected stepsize default (1 → 1.0), documented all three
  moving overloads, added # Returns section and a jldoctest example
- prepare_value_axes: replaced broken Interpolations v0.14-era indexing
  example with accurate description of current internals
- Add Documenter as test dependency; run doctest(RegisterHindsight; manual=false)
  in runtests.jl

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

codecov Bot commented May 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.25%. Comparing base (c53a8eb) to head (41365f8).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #27   +/-   ##
=======================================
  Coverage   99.25%   99.25%           
=======================================
  Files           1        1           
  Lines         135      135           
=======================================
  Hits          134      134           
  Misses          1        1           

☔ 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 e02660c into master May 14, 2026
4 checks passed
@kdw503
kdw503 deleted the dwk/mng branch May 14, 2026 18:43
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