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

FrameGenerator missing a Python docstring #1040

Open
dbogdanov opened this issue Aug 31, 2020 · 1 comment · May be fixed by #1420
Open

FrameGenerator missing a Python docstring #1040

dbogdanov opened this issue Aug 31, 2020 · 1 comment · May be fixed by #1420
Labels
documentation

Comments

@dbogdanov
Copy link
Member

The FrameGenerator algorithm is missing a docstring for documetation in Python.

We can add it in a custom way inside algorithms.py using setattribute.
@awagenknecht awagenknecht linked a pull request May 30, 2024 that will close this issue
Open
@awagenknecht
Copy link

Hello! I'm new here and looking to contribute. Please let me know if this documentation should be done differently.

I have included inputs and outputs in the docstring although they are not present in the __struct__ because I think it provides clarity. I am wondering if the input audio argument should be included in __struct__ since it is a required argument to initialize an object of this class.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add FrameGenerator docstring (#1040) awagenknecht/essentia
2 participants
@dbogdanov @awagenknecht