-
Notifications
You must be signed in to change notification settings - Fork 113
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding documentation for bilinear function (#527)
* Adding documentation for bilinear function This commit adds documentation for the bilinear function in the `Filters` module. docstrings are added in source code for the two methods of bilinear function with the top level method explained in detail to providde a clear explanation of what the transform function is doing. The function is also added to the export list in `Filters.jl` so that it is available for Documenter and also for users to use. The documentation is added to the `docs/src/filters.md` file in the `Filters` module, Filter design section where the bilinear function is added as a general digital filter design method. No code has been changed in this commit, only documentation has been added and an extra function has been added to the export list. --------- Co-authored-by: wheeheee <[email protected]>
- Loading branch information
1 parent
3ad3c1c
commit 8a93c2a
Showing
3 changed files
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -40,6 +40,7 @@ export FilterType, | |
Bandstop, | ||
analogfilter, | ||
digitalfilter, | ||
bilinear, | ||
iirnotch, | ||
kaiserord, | ||
FIRWindow, | ||
|
This file contains 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