[DOC] Migrate _rnn.py docstrings from Google style to NumPyDoc style#2173
Open
Abhishek242004 wants to merge 1 commit intosktime:mainfrom
Open
[DOC] Migrate _rnn.py docstrings from Google style to NumPyDoc style#2173Abhishek242004 wants to merge 1 commit intosktime:mainfrom
Abhishek242004 wants to merge 1 commit intosktime:mainfrom
Conversation
phoeenniixx
requested changes
Mar 22, 2026
Member
phoeenniixx
left a comment
There was a problem hiding this comment.
The code-quality is failing, please use pre-commit before pushing
https://www.sktime.net/en/stable/developer_guide/coding_standards.html#setting-up-local-code-quality-checks
This file contains hidden or 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
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.
Reference Issues/PRs
Fixes #2066
What does this implement/fix? Explain your changes.
This PR migrates the docstrings in
pytorch_forecasting/models/.../_rnn.pyfrom Google style to NumPy docstring style to align with the project's documentation standards and the ongoing migration described in #2066.The following updates were made:
Args:andReturns:to NumPy-style sections likeParameters,Returns, andAttributes.These changes are purely documentation improvements and do not affect the functionality of the code.
What should a reviewer concentrate their feedback on?
forwardmethodsDid you add any tests for the change?
No. This is a documentation-only change.
Any other comments?
PR checklist
pre-commit install.To run hooks independent of commit, execute
pre-commit run --all-files-->