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

ENH: improve Function.low_pass_filter and adds docs #538

Merged
merged 1 commit into from
Jan 23, 2024

Conversation

Gui-FernandesBR
Copy link
Member

Pull request type

  • Code maintenance (refactoring, formatting, tests)
  • ReadMe, Docs and GitHub updates

Checklist

  • Docs have been reviewed and added / updated
  • Lint (black rocketpy/ tests/) has passed locally
  • All tests (pytest --runslow) have passed locally
  • CHANGELOG.md has been updated (if relevant)

Current behavior

While using the new low_pass_filter method, I noticed some minor adjustments could be done, let's see:

New behavior

  • Persist the inputs, outputs and title of the original Function
  • Improve the method docstring
  • Add an example to the .rst file

Breaking change

  • No

- Persist the inputs, outputs and title of the original Function
- Improve the method docstring
- Add an example to the .rst file
@Gui-FernandesBR Gui-FernandesBR requested a review from a team as a code owner January 23, 2024 04:34
@Gui-FernandesBR Gui-FernandesBR added Enhancement New feature or request, including adjustments in current codes Docs Docs and examples related labels Jan 23, 2024
@Gui-FernandesBR Gui-FernandesBR changed the title MNT: improve the low pass filter and document an example ENH: improve Function.low_pass_filter and adds docs Jan 23, 2024
@Gui-FernandesBR Gui-FernandesBR added this to the Release v1.X.0 milestone Jan 23, 2024
@Gui-FernandesBR
Copy link
Member Author

This is how the new docs look like:

image

Copy link

codecov bot commented Jan 23, 2024

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (ead9219) 72.32% compared to head (7895a1e) 72.33%.

Files Patch % Lines
rocketpy/mathutils/function.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #538      +/-   ##
===========================================
+ Coverage    72.32%   72.33%   +0.01%     
===========================================
  Files           56       56              
  Lines         9389     9389              
===========================================
+ Hits          6791     6792       +1     
+ Misses        2598     2597       -1     

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

@Gui-FernandesBR Gui-FernandesBR merged commit 08d3a42 into develop Jan 23, 2024
11 of 12 checks passed
@Gui-FernandesBR Gui-FernandesBR deleted the enh/minor_adjst_function_filters branch January 23, 2024 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Docs and examples related Enhancement New feature or request, including adjustments in current codes
Projects
Status: Closed
Development

Successfully merging this pull request may close these issues.

2 participants