Skip to content

Package maintenance: quality, coverage, docs, v1.0.0#25

Merged
kdw503 merged 7 commits intomasterfrom
dkw/mng
May 8, 2026
Merged

Package maintenance: quality, coverage, docs, v1.0.0#25
kdw503 merged 7 commits intomasterfrom
dkw/mng

Conversation

@kdw503
Copy link
Copy Markdown
Member

@kdw503 kdw503 commented May 8, 2026

Summary

  • Aqua.jl quality checks added to test suite; all checks pass
  • ExplicitImports.jl audit added; all imports made explicit
  • Test coverage improved from 75.7% to 93.5%
  • Docstrings added for all exported symbols (driver, mm_package_loader, threadids); doctests wired into CI
  • Documenter.jl docs site added (docs/) with Home and API Reference pages; CI deploys to GitHub Pages via julia-docdeploy
  • README expanded with badges (CI, coverage, docs), installation instructions (HolyLab registry), concepts section, and usage examples
  • Version bumped to 1.0.0

Test plan

  • CI passes on min and 1 Julia versions
  • Docs job builds and deploys successfully (requires DOCUMENTER_KEY secret to be set in repo settings)
  • Review README and docs site content

🤖 Generated with Claude Code

kdw503 and others added 7 commits May 8, 2026 09:31
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>
- Fix bug: `create_dataset` and `create_group` were used but not imported
  from HDF5; the old compat shims only defined them as aliases when HDF5
  *lacked* them (backwards logic). Now imported explicitly; dead shims removed.
- Remove dead code: `copy_all_but_shared!` was unexported and never called.
- Add test for non-BitsType array (Vector{ComplexF32}) alongside an
  unpackable string, covering the group-write path (line 98) and the
  non-BitsType branch in initialize_jld! (line 169). Requires new Alg4
  in WorkerDummy.
- Add test for the single-image in-memory driver variant and its error path.
- Add unit tests for all three nicehdf5 specializations: plain SharedArray,
  StaticArray-element arrays, and NumDenom-element arrays.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Module docstring for RegisterDriver
- Rewrote driver docstrings: proper signature blocks, imperative mood,
  return values, examples for both the file-saving and in-memory variants
- New docstrings for mm_package_loader and threadids
- Added Documenter.jl as a test dependency with a doctest testset
  (manual=false, docstrings only)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add Documenter.jl docs/ with Home and API Reference pages
- Add docs CI job (julia-docdeploy) that deploys to GitHub Pages
- Expand README with badges (CI, coverage, docs), installation
  instructions, concepts section, and usage examples
- Bump version to 1.0.0

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 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.26%. Comparing base (a885a8b) to head (7217ddf).

Additional details and impacted files
@@             Coverage Diff             @@
##           master      #25       +/-   ##
===========================================
+ Coverage   74.31%   91.26%   +16.95%     
===========================================
  Files           1        1               
  Lines         109      103        -6     
===========================================
+ Hits           81       94       +13     
+ Misses         28        9       -19     

☔ 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 31303c0 into master May 8, 2026
5 checks passed
@kdw503 kdw503 deleted the dkw/mng branch May 8, 2026 16:29
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