search

fraunhoferportugal / tsfel

An intuitive library to extract features from time series.
https://tsfel.readthedocs.io
BSD 3-Clause "New" or "Revised" License
925 stars 143 forks source link

Incorrect API Reference in Documentation Example Code (tsfel.time_series_feature_extractor vs. tsfel.time_series_features_extractor) #169

Open hide-on-bush-lalala opened 4 days ago

hide-on-bush-lalala commented 4 days ago

As shown in the documentation page provided for your project, the images and example code use the function tsfel.time_series_feature_extractor to call the feature extraction tool. However, based on my actual usage, in version 0.1.9, the API for this function in your library has changed to tsfel.time_series_features_extractor. I'm not sure in which version this update occurred, but I kindly ask you to update the example code on your documentation page as soon as possible, as it caused some confusion for me as a first-time user of your library.

Thank you very much for your contribution to the open-source community!

{AA05A6A4-6782-4545-9DE6-352EA28C74BE}

dmfolgado commented 2 days ago

Hey! Thanks for the feedback. You're right, there’s a typo in the image used in the documentation. I’ll fix it soon. Appreciate you pointing that out!

dmfolgado commented 2 days ago

Documentation updated.