Adding documentation for bilinear function #527
Merged
Conversation
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 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.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #527 +/- ##
=======================================
Coverage 97.49% 97.49%
=======================================
Files 18 18
Lines 3078 3078
=======================================
Hits 3001 3001
Misses 77 77 ☔ View full report in Codecov by Sentry. |
|
Sorry @anchal-physics, could you rebase on master and resolve the conflicts? |
|
I resolved the conflict. I wonder if we should tag a 0.8 release in the next couple of weeks or so. If someone can review this and merge, that will be great to get into the new release (but of course it is a doc change and can also happen any time). |
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.
This addresses #518
This PR adds documentation for the bilinear function in the
Filtersmodule. 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 bilinear function is also added to the export list in
Filters.jlso that it is available for Documenter and also for users to use.The documentation is added to the
docs/src/filters.mdfile in theFiltersmodule, Filter design section where the bilinear function is added as a general digital filter design method.No code has been changed in this PR, only documentation has been added and an extra function has been added to the export list.