Skip to content

[DOC] Improve data subpackage docstring for clarity and consistency (Closes #2092)#2112

Merged
phoeenniixx merged 1 commit intosktime:mainfrom
vinitjain2005:improve-data-docstring
Mar 1, 2026
Merged

[DOC] Improve data subpackage docstring for clarity and consistency (Closes #2092)#2112
phoeenniixx merged 1 commit intosktime:mainfrom
vinitjain2005:improve-data-docstring

Conversation

@vinitjain2005
Copy link
Contributor

Reference Issues/PRs

Closes #2092

What does this implement/fix? Explain your changes.

This PR improves the module-level docstring in
pytorch_forecasting/data/__init__.py.

The previous docstring was brief and contained a minor grammatical issue.
This update fixes the grammar and provides a clearer description of the
subpackage’s purpose while keeping consistency with other subpackages.

No functional changes are introduced.

What should a reviewer concentrate their feedback on?

  • Clarity and accuracy of the updated docstring
  • Consistency with documentation style across the repository

Did you add any tests for the change?

No. This PR only modifies documentation and does not change functionality.

Any other comments?

None.

PR checklist

  • The PR title starts with either [ENH], [MNT], [DOC], or [BUG].
  • Added/modified tests
  • Used pre-commit hooks when committing to ensure that code is compliant with hooks.

Github: @vinitjain2005

@codecov
Copy link

codecov bot commented Feb 28, 2026

Codecov Report

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

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

@vinitjain2005
Copy link
Contributor Author

Hi @phoeenniixx please review my pull request

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 a lot!

@phoeenniixx phoeenniixx added the documentation Improvements or additions to documentation label Mar 1, 2026
@phoeenniixx phoeenniixx merged commit 6b27898 into sktime:main Mar 1, 2026
36 checks passed
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.

[DOC] Improve module docstring in pytorch_forecasting/data/__init__.py

2 participants