Skip to content

docs: update documentation, add docstrings, and add Aqua tests#92

Merged
zsoerenm merged 2 commits intomasterfrom
ss/update-documentation
Jan 14, 2026
Merged

docs: update documentation, add docstrings, and add Aqua tests#92
zsoerenm merged 2 commits intomasterfrom
ss/update-documentation

Conversation

@zsoerenm
Copy link
Member

Preparation for version 1.0.0

  • Add docstrings to all exported functions and types
  • Update documentation to reflect API changes from recent refactors
  • Convert documentation examples to doctests for automatic testing
  • Remove obsolete tracking_results.md (TrackingResults was removed)
  • Add docs/Project.toml for separate documentation environment
  • Add GitHub Actions workflow for Documenter deployment
  • Remove Documenter from main package dependencies
  • Fix typo "und" -> "and" in downconvert_and_correlate_cpu.jl
  • Fix incomplete docstring for DefaultPostCorrFilter
  • Remove invalid export CPUSatDownconvertAndCorrelator
  • Fix unbound type parameters in merge_sats function
  • Move Adapt to weakdeps (only needed by CUDA extension)
  • Add LinearAlgebra compat entry
  • Add Aqua.jl tests for code quality checks

@zsoerenm zsoerenm requested a review from siebc January 12, 2026 12:36
@zsoerenm zsoerenm self-assigned this Jan 12, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 12, 2026

Benchmark Results (Julia v1)

Time benchmarks
master a80f442... master / a80f442...
downconvert and correlate/CPU/Float32 3.05 ± 0.021 μs 3 ± 0.021 μs 1.02 ± 0.01
downconvert and correlate/CPU/Float64 3.52 ± 0.029 μs 3.48 ± 0.02 μs 1.01 ± 0.01
downconvert and correlate/CPU/Int16 3.09 ± 0.021 μs 3.05 ± 0.029 μs 1.01 ± 0.012
downconvert and correlate/CPU/Int32 3.07 ± 0.029 μs 3.04 ± 0.029 μs 1.01 ± 0.014
track/Float32 3.35 ± 0.07 μs 3.33 ± 0.07 μs 1.01 ± 0.03
time_to_load 1.04 ± 0.023 s 0.995 ± 0.016 s 1.04 ± 0.029
Memory benchmarks
master a80f442... master / a80f442...
downconvert and correlate/CPU/Float32 2 allocs: 0.359 kB 2 allocs: 0.359 kB 1
downconvert and correlate/CPU/Float64 2 allocs: 0.359 kB 2 allocs: 0.359 kB 1
downconvert and correlate/CPU/Int16 2 allocs: 0.359 kB 2 allocs: 0.359 kB 1
downconvert and correlate/CPU/Int32 2 allocs: 0.359 kB 2 allocs: 0.359 kB 1
track/Float32 12 allocs: 1.67 kB 12 allocs: 1.67 kB 1
time_to_load 0.145 k allocs: 11 kB 0.145 k allocs: 11 kB 1

@zsoerenm zsoerenm force-pushed the ss/update-documentation branch 2 times, most recently from c43cb2a to 6af600f Compare January 12, 2026 13:07
@codecov
Copy link

codecov bot commented Jan 12, 2026

Codecov Report

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

Additional details and impacted files
@@            Coverage Diff             @@
##           master      #92      +/-   ##
==========================================
+ Coverage   80.30%   80.50%   +0.20%     
==========================================
  Files          23       23              
  Lines         660      667       +7     
==========================================
+ Hits          530      537       +7     
  Misses        130      130              

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

- Add docstrings to all exported functions and types
- Update documentation to reflect API changes from recent refactors
- Convert documentation examples to doctests for automatic testing
- Remove obsolete tracking_results.md (TrackingResults was removed)
- Add docs/Project.toml for separate documentation environment
- Add GitHub Actions workflow for Documenter deployment
- Remove Documenter from main package dependencies
- Fix typo "und" -> "and" in downconvert_and_correlate_cpu.jl
- Fix incomplete docstring for DefaultPostCorrFilter
- Remove invalid export CPUSatDownconvertAndCorrelator
- Fix unbound type parameters in merge_sats function
- Move Adapt to weakdeps (only needed by CUDA extension)
- Add LinearAlgebra compat entry
- Add Aqua.jl tests for code quality checks

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@zsoerenm zsoerenm force-pushed the ss/update-documentation branch from 2a0d019 to 77dcfc2 Compare January 13, 2026 04:26
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.

2 participants