[DOC] Migrate docstrings in models/nn/rnn.py to numpydoc format#2198
Open
sohamjadhav95 wants to merge 2 commits intosktime:mainfrom
Open
[DOC] Migrate docstrings in models/nn/rnn.py to numpydoc format#2198sohamjadhav95 wants to merge 2 commits intosktime:mainfrom
sohamjadhav95 wants to merge 2 commits intosktime:mainfrom
Conversation
20 tasks
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2198 +/- ##
=======================================
Coverage ? 86.67%
=======================================
Files ? 166
Lines ? 9756
Branches ? 0
=======================================
Hits ? 8456
Misses ? 1300
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
phoeenniixx
requested review from
PranavBhatP,
benHeid,
fkiraly,
fnhirwa,
jdb78 and
yarnabrina
as code owners
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
2 participants
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
References #2066 and closes #2196
What does this implement/fix?
Migrates all Google-style (
Args:/Returns:) docstrings inpytorch_forecasting/models/nn/rnn.pyto numpydoc format (Parameters\n----------/Returns\n-------), consistent with the ongoing migration in #2083 and #2079.Files changed
pytorch_forecasting/models/nn/rnn.py. 5 docstrings convertedNo logic changes. Documentation only.