[x] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
Description
The current docstring example for the method_to_transform decorator in gtda.mapper became incorrect following changes that reshape the output of the new transform method to ensure it is at least 2D. This PR documents this reshaping in the docstring and fixes the example.
Types of changes
Description The current docstring example for the
method_to_transform
decorator ingtda.mapper
became incorrect following changes that reshape the output of the newtransform
method to ensure it is at least 2D. This PR documents this reshaping in the docstring and fixes the example.Checklist
flake8
to check my Python changes.I have added tests to cover my changes.pytest
to check this on Python tests.