Skip to content

[DOC] Migration of docstrings in layers/_filter to NumPydoc style#2116

Merged
phoeenniixx merged 1 commit intosktime:mainfrom
AyushDineshRathi:fix/filter-docstring-numpy-style
Mar 2, 2026
Merged

[DOC] Migration of docstrings in layers/_filter to NumPydoc style#2116
phoeenniixx merged 1 commit intosktime:mainfrom
AyushDineshRathi:fix/filter-docstring-numpy-style

Conversation

@AyushDineshRathi
Copy link
Contributor

Closes Part of #2066

This PR converts the docstrings in layers/_filter from Google style to NumPy style to maintain documentation consistency across the project.

Files modified:

  • _moving_avg_filter.py

No functional changes were made.

@codecov
Copy link

codecov bot commented Mar 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@941097c). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2116   +/-   ##
=======================================
  Coverage        ?   86.63%           
=======================================
  Files           ?      165           
  Lines           ?     9732           
  Branches        ?        0           
=======================================
  Hits            ?     8431           
  Misses          ?     1301           
  Partials        ?        0           
Flag Coverage Δ
cpu 86.63% <ø> (?)
pytest 86.63% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Member

@phoeenniixx phoeenniixx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@phoeenniixx phoeenniixx changed the title Migration of docstrings in layers/_filter to NumPydoc style [DOC] Migration of docstrings in layers/_filter to NumPydoc style Mar 1, 2026
@phoeenniixx phoeenniixx added the documentation Improvements or additions to documentation label Mar 1, 2026
@phoeenniixx phoeenniixx merged commit fee1b29 into sktime:main Mar 2, 2026
36 checks passed
@AyushDineshRathi AyushDineshRathi deleted the fix/filter-docstring-numpy-style branch March 3, 2026 18:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants