docs: correct FIR interpolator initialization return status - #347
Open
SherTheCoder wants to merge 2 commits into
Open
docs: correct FIR interpolator initialization return status#347SherTheCoder wants to merge 2 commits into
SherTheCoder wants to merge 2 commits into
Conversation
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
1 participant
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.
The Doxygen return-value comments for the F32, Q15, and Q31 FIR interpolator initialization functions identify
ARM_MATH_ARGUMENT_ERRORas the result whennumTapsis not divisible by the interpolation factorL.All three implementations actually return
ARM_MATH_LENGTH_ERRORfor this condition.This PR corrects the three comments to match the existing behavior.