Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Added examples for temporal_train_test_split docstring #5216

Merged
merged 8 commits into from Sep 13, 2023

Conversation

JonathanBechtel
Copy link
Contributor

Reference Issues/PRs

#4154

What does this implement/fix? Explain your changes.

I added better documentation for the temporal_train_test_split function, as it lacks examples

Does your contribution introduce a new dependency? If yes, which one?

No

What should a reviewer concentrate their feedback on?

Make sure examples are relevant and accurate

Did you add any tests for the change?

This is just a doc string fix, so no tests were added

Any other comments?

No

PR checklist

For all contributions
  • [ x] I've added myself to the list of contributors with any new badges I've earned :-)
    How to: add yourself to the all-contributors file in the sktime root directory (not the CONTRIBUTORS.md). Common badges: code - fixing a bug, or adding code logic. doc - writing or improving documentation or docstrings. bug - reporting or diagnosing a bug (get this plus code if you also fixed the bug in the PR).maintenance - CI, test framework, release.
    See here for full badge reference
  • Optionally, I've added myself and possibly others to the CODEOWNERS file - do this if you want to become the owner or maintainer of an estimator you added.
    See here for further details on the algorithm maintainer role.
  • [ x] The PR title starts with either [ENH], [MNT], [DOC], or [BUG]. [BUG] - bugfix, [MNT] - CI, test framework, [ENH] - adding or improving code, [DOC] - writing or improving documentation or docstrings.
For new estimators
  • I've added the estimator to the API reference - in docs/source/api_reference/taskname.rst, follow the pattern.
  • I've added one or more illustrative usage examples to the docstring, in a pydocstyle compliant Examples section.
  • If the estimator relies on a soft dependency, I've set the python_dependencies tag and ensured
    dependency isolation, see the estimator dependencies guide.

@JonathanBechtel JonathanBechtel changed the title [DOC] Added examples for temporal_train_test_split function [DOC] Added examples for temporal_train_test_split docstring Sep 12, 2023
Copy link
Collaborator

@fkiraly fkiraly left a comment

Choose a reason for hiding this comment

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

typo - _make_panel is from sktime.utils._testing.panel

@fkiraly fkiraly added documentation Documentation & tutorials module:metrics&benchmarking metrics and benchmarking modules labels Sep 12, 2023
@JonathanBechtel
Copy link
Contributor Author

@fkiraly Thank you, fixed.

@fkiraly fkiraly merged commit cda7ac1 into sktime:main Sep 13, 2023
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation & tutorials module:metrics&benchmarking metrics and benchmarking modules
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants