Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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 this issue Oct 16, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to TSFEL documentation

Comments

@hide-on-bush-lalala
Copy link

hide-on-bush-lalala commented Oct 16, 2024

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 dmfolgado self-assigned this Oct 17, 2024
@dmfolgado dmfolgado added the documentation Improvements or additions to TSFEL documentation label Oct 17, 2024
@dmfolgado
Copy link
Member

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
Copy link
Member

Documentation updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to TSFEL documentation
Projects
None yet
Development

No branches or pull requests

2 participants