[DOC] Adjust FunctionTransformer's docstring
#5634
Merged
Conversation
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
FunctionTransformer's docstringFunctionTransformer's docstring
6 tasks
yarnabrina
approved these changes
Dec 18, 2023
Member
yarnabrina
left a comment
There was a problem hiding this comment.
Seems fine.
(Note: even a class can be a callable object, and I doubt that is supported. So I'm a bit hesitant for use of that word, but otherwise it's all good.)
Contributor
Author
|
Technically it is supported if you do it right, but its quite out there indeed 😄 >>> class Foo():
... def __new__(cls, X):
... return X[::-1]
>>> Foo([1, 2, 3])
[3, 2, 1]
>>> type(Foo([]))
<class 'list'>So technically it does accept any callable that follows the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
Relates to #5630
What does this implement/fix? Explain your changes.
Small adjustment to
FunctionTransformer's docstring, related to changed made in #5630PR checklist
For all contributions
How to: add yourself to the all-contributors file in the
sktimeroot directory (not theCONTRIBUTORS.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 pluscodeif you also fixed the bug in the PR).maintenance- CI, test framework, release.See here for full badge reference
See here for further details on the algorithm maintainer role.
For new estimators
docs/source/api_reference/taskname.rst, follow the pattern.Examplessection.python_dependenciestag and ensureddependency isolation, see the estimator dependencies guide.