Merged
Conversation
Contributor
Collaborator
|
Hm, looks like it has been already solved in #877. Will merge both for credit. |
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
Fixes #768
Depends on #767 (class-based tag system, already merged)
What does this implement/fix? Explain your changes.
This PR adds a comprehensive tag documentation page to the
skproAPI reference, following the same pattern established bysktime(seesktime'stags.rst).Tags in
skprodescribe properties, capabilities, and behavior of objects such as estimators, distributions, and metrics. Previously, these tags were only discoverable in the source codeskpro.registry._tags. This change provides a centralized documentation page listing and organizing them.Changes:
New file: [docs/source/api_reference/tags.rst]
autosummarydirective for theall_tagsutility functionskpro.registry._tagsModified: [docs/source/api_reference.rst]
api_reference/tagsentry to the main API reference toctree (placed betweenmetricsandbase)Does your contribution introduce a new dependency? If yes, which one?
No.
Any other comments?
This follows the exact same documentation pattern used in
sktime, making it easy for contributors familiar with thesktimeecosystem to navigateskpro's tag system. All 30 tags currently defined inskpro.registry._tagsare covered.