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.

Sign up for GitHub

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

Jump to bottom

The docstrings in extract_wavelets is not good enough #112

Closed
Catarina-Alves opened this issue Apr 10, 2019 · 1 comment
Closed

The docstrings in extract_wavelets is not good enough #112

Catarina-Alves opened this issue Apr 10, 2019 · 1 comment
Assignees
@Catarina-Alves
Labels
enhancement Improvement to existing functionality or implementation, including adding a new functions/methods.

Comments

@Catarina-Alves
Copy link
Collaborator

First, sometimes, the coefficients are called waveout and other times wavout. This is inconsistent.
Second, the description of wavout is not enough as it does not say what is it inside each entry and in which order.

I propose to make better docstrings or to re-do some of the functions used in extract_wavelets. I would make them more clear and modular.
This is also related to #76 and #78.
@Catarina-Alves Catarina-Alves added the enhancement Improvement to existing functionality or implementation, including adding a new functions/methods. label Apr 10, 2019
@Catarina-Alves Catarina-Alves mentioned this issue Apr 11, 2019
Closed
@Catarina-Alves Catarina-Alves self-assigned this Jun 19, 2020
@Catarina-Alves
Copy link
Collaborator Author

Solved by #219.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Catarina-Alves Catarina-Alves

Labels
enhancement Improvement to existing functionality or implementation, including adding a new functions/methods.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Catarina-Alves