Skip to content

[DOC] migrate _output and _decomposition docstrings to numpydoc style#2120

Open
Meet-Ramjiyani-10 wants to merge 2 commits intosktime:mainfrom
Meet-Ramjiyani-10:doc/migrate-output-decomp-numpydoc
Open

[DOC] migrate _output and _decomposition docstrings to numpydoc style#2120
Meet-Ramjiyani-10 wants to merge 2 commits intosktime:mainfrom
Meet-Ramjiyani-10:doc/migrate-output-decomp-numpydoc

Conversation

@Meet-Ramjiyani-10
Copy link
Contributor

@Meet-Ramjiyani-10 Meet-Ramjiyani-10 commented Mar 1, 2026

Addresses #2066

Migrated docstrings in

  • pytorch_forecasting/layers/_output/_flatten_head.py
  • pytorch_forecasting/layers/_decomposition/_series_decomp.py

from Google style to numpydoc style.

No logic changes, documentation only.

@Meet-Ramjiyani-10 Meet-Ramjiyani-10 changed the title [DOC] fix end of file newline in _series_decomp.py [DOC] migrate _output and _decomposition docstrings to numpydoc style Mar 1, 2026
@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@cf46d07). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2120   +/-   ##
=======================================
  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.

Number of input features.
nf : int
Number of features in the last layer.
target_window : int
Copy link
Member

Choose a reason for hiding this comment

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

I think the indentation is a bit off here?

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! just a point about indentation

@phoeenniixx phoeenniixx added the documentation Improvements or additions to documentation label Mar 5, 2026
@Meet-Ramjiyani-10
Copy link
Contributor Author

Meet-Ramjiyani-10 commented Mar 5, 2026

@phoeenniixx
Thanks for pointing it out . i have updated it

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