docs: update documentation, add docstrings, and add Aqua tests#92
Merged
docs: update documentation, add docstrings, and add Aqua tests#92
Conversation
Contributor
Benchmark Results (Julia v1)Time benchmarks
Memory benchmarks
|
c43cb2a to
6af600f
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
6af600f to
2a0d019
Compare
- 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>
2a0d019 to
77dcfc2
Compare
siebc
approved these changes
Jan 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Preparation for version 1.0.0