[DOC] API reference for data representations#7231
Merged
Conversation
Collaborator
Author
|
(the class docstrings are currently empty, but this PR sets up the framework for the documentation) |
Collaborator
Author
|
FYI @sktime/core-developers, I am planning a merge as-is - I started documenting the most frequently used mtypes, the rest can be filled in by the community following the pattern, imo. |
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
1 participant
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.
This PR adds documentation for the data representations, by using the docstrings of the specification classes introduced in #7161 as records.
Closes #1434
Depends on #7161 which should be merged first.