DASDAE / dascore

A python library for distributed fiber optic sensing
Other
71 stars 16 forks source link

add notes for using apply with rolling #412

Closed ahmadtourei closed 1 month ago

ahmadtourei commented 1 month ago

Description

This PR improves Patch.rolling function's docs. It adds notes and an example of how to apply a desired function to the patch along with the rolling operator.

Checklist

I have (if applicable):

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 99.84%. Comparing base (fa08013) to head (f2ea487). Report is 3 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #412 +/- ## ======================================== Coverage 99.84% 99.84% ======================================== Files 109 112 +3 Lines 8843 8980 +137 ======================================== + Hits 8829 8966 +137 Misses 14 14 ``` | [Flag](https://app.codecov.io/gh/DASDAE/dascore/pull/412/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DASDAE) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/DASDAE/dascore/pull/412/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DASDAE) | `99.84% <ø> (+<0.01%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DASDAE#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.