Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Annotate docstring arguments with types in Filters #552

Merged
merged 2 commits into from
Apr 12, 2024

Conversation

wheeheee
Copy link
Contributor

@wheeheee wheeheee commented Mar 1, 2024

Addresses some concerns in #548 and implements the type restriction in #367.

Copy link

codecov bot commented Mar 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.75%. Comparing base (c4f42fc) to head (c5daa66).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #552      +/-   ##
==========================================
- Coverage   97.75%   97.75%   -0.01%     
==========================================
  Files          18       18              
  Lines        3202     3201       -1     
==========================================
- Hits         3130     3129       -1     
  Misses         72       72              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

src/dspbase.jl Outdated
@@ -5,10 +5,12 @@ const SMALL_FILT_CUTOFF = 58
_zerosi(b,a,T) = zeros(promote_type(eltype(b), eltype(a), T), max(length(a), length(b))-1)

"""
filt(b, a, x, [si])
filt(b::Union{AbstractVector,Number}, a::Union{AbstractVector,Number}, x, [si])
Copy link
Contributor

@s-celles s-celles Mar 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

x is AbstractArray

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's a bit fat now, though...

@wheeheee wheeheee force-pushed the annotate_types branch 2 times, most recently from c5e63aa to 13f972d Compare March 13, 2024 08:42
@ViralBShah
Copy link
Contributor

Merge?

@wheeheee
Copy link
Contributor Author

Mostly documentation, so it should be safe, but still needs an approval to merge

@ViralBShah
Copy link
Contributor

For obvious PRs, there is the button on "Merge without waiting for requirements to be met". I would recommend using it for various docs and maintenance PRs.

@wheeheee wheeheee merged commit 48e00f9 into JuliaDSP:master Apr 12, 2024
10 checks passed
@wheeheee wheeheee deleted the annotate_types branch April 12, 2024 07: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.

3 participants