giotto-ai / giotto-tda

A high-performance topological machine learning toolbox in Python
https://giotto-ai.github.io/gtda-docs
Other
858 stars 175 forks source link

Fix issues with docstring of `gtda.mapper.method_to_transform` #396

Closed ulupo closed 4 years ago

ulupo commented 4 years ago

Types of changes

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.

Checklist