Skip to content

Package maintenance: quality checks, coverage, docs, v1.0.0#18

Merged
kdw503 merged 10 commits intomasterfrom
dwk/mng
May 8, 2026
Merged

Package maintenance: quality checks, coverage, docs, v1.0.0#18
kdw503 merged 10 commits intomasterfrom
dwk/mng

Conversation

@kdw503
Copy link
Copy Markdown
Member

@kdw503 kdw503 commented May 8, 2026

Summary

  • Add Manifest-v*.toml to .gitignore
  • Add Aqua.jl quality checks to test suite
  • Add ExplicitImports.jl to test suite; make all imports explicit
  • Improve test coverage: 63.7% → 75.7%
  • Improve docstrings; convert examples to jldoctest blocks (verified by CI)
  • Add README with badges, installation instructions, and quick-start examples
  • Add Documenter.jl docs/ with concepts page and full API reference
  • Add doc deployment job to CI (via julia-docdeploy)
  • Bump version to 1.0.0

Test plan

  • CI passes (tests + doctests + Aqua + ExplicitImports)
  • Doc deployment job succeeds and gh-pages branch is created
  • Stable/dev doc badges resolve after first tagged release

🤖 Generated with Claude Code

kdw503 and others added 10 commits May 8, 2026 11:42
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
All 11 Aqua checks pass; adding to prevent regressions.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replace bare `using` statements with explicit name lists, and change
`using Base: @nLoops, @nexprs, @nref, @nif` to
`import Base.Cartesian: ...` to correctly attribute their owner.
Adds test_explicit_imports to the test suite to prevent regressions.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Fix two broken symbols in src/:
- Replace indmin_mismatch with argmin_mismatch (renamed in RegisterCore)
- Fix pat_rotation wrapper: replace eye() with Matrix{Float64}(I, n, n)

Add tests for previously uncovered functions:
- uisvalid and uclamp!
- qfit all-below-threshold early return
- optimize_per_aperture
- mms2fit!
- pat_rotation(array, array) convenience wrapper

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Rewrote all exported function docstrings: imperative mood, indented
  signatures, documented return types, fixed the qbuild u0→umin arg
  name mismatch, fixed mms2fit! dangling reference to fixed_λ/auto_λ
  (now qualified as RegisterPenalty.*), clarified uisvalid domain
  condition, documented N-dimensionality constraint in mms2fit!, and
  added jldoctest examples for principalaxes, uisvalid, and uclamp!
- Added Documenter.jl as a test dependency with a Doctests testset

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- README.md: badges (CI, Codecov, stable/dev docs), HolyLabRegistry
  install instructions, two quick-start examples, workflow overview
- docs/: Project.toml, make.jl, src/index.md (concepts + workflow),
  src/api.md (full API reference via @docs blocks)
- CI.yml: add docs job using julia-docdeploy with DOCUMENTER_KEY
- Convert five docstring examples from unverified julia blocks to
  jldoctest blocks (qfit, qbuild, optimize_per_aperture, mms2fit!,
  pat_rotation); update DocTestSetup to include RegisterCore

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>
Base.tail is not a public API; ExplicitImports CI was flagging it.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@codecov
Copy link
Copy Markdown

codecov Bot commented May 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.46%. Comparing base (71ad820) to head (b828f17).

Additional details and impacted files
@@             Coverage Diff             @@
##           master      #18       +/-   ##
===========================================
+ Coverage   63.49%   75.46%   +11.96%     
===========================================
  Files           1        1               
  Lines         326      326               
===========================================
+ Hits          207      246       +39     
+ Misses        119       80       -39     

☔ 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 d3742db into master May 8, 2026
5 checks passed
@kdw503 kdw503 deleted the dwk/mng branch May 8, 2026 19:07
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