Repository navigation
[DOC] Document HierarchicalPolarsEager mtype - #10318
Merged
Merged
Conversation
AMBRA7592
requested review from
SimonBlanke,
benHeid,
felipeangelimvieira,
fkiraly,
geetu040,
jgyasu,
marrov and
yarnabrina
as code owners
June 2, 2026 16:08
Contributor
Author
|
Following up on this docstring-only PR, which has been ready for review since June 2. Is this contribution still useful? I can update it against current main if needed. |
fkiraly
added
documentation
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
Part of #7386.
What does this implement/fix? Explain your changes.
Adds detailed mtype documentation for
HierarchicalPolarsEager, following the structure used by the neighboring hierarchical data type docstrings.Does your contribution introduce a new dependency? If yes, which one?
No.
What should a reviewer concentrate their feedback on?
HierarchicalPolarsEagerdescription matches the intended polars hierarchical mtype convention.Did you add any tests for the change?
No tests added; this is a docstring-only documentation change.
Validation run locally:
python3 -m py_compile sktime/datatypes/_hierarchical/_check.pygit diff --checkAny other comments?
None.
PR checklist
For all contributions
maintainerstag.