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

[JOSS review] Docstrings missing information for output parameters #11

Open
justinsalamon opened this issue May 28, 2020 · 1 comment
Open

Comments

@justinsalamon
Copy link

The docstrings are missing information about what the augmentation functions actually return.

For example, the docs for fade_in_and_out say:

pydiogment.auga.fade_in_and_out(infile)
Add a fade in and out effect to the audio file.

Args:
infile (str) : input filename/path.

This doesn't explain where the processed audio goes (saved to disk? returned as numpy array? as some other data format?), and whether there are other output parameters. The same applies to the other augmentation functions.

@justinsalamon justinsalamon changed the title Docstrings missing information for output parameters [JOSS review] Docstrings missing information for output parameters May 28, 2020
@bmcfee
Copy link

bmcfee commented Jun 5, 2020

Seconding this: having a handle to the output of one augmenter is crucial if a user wants to apply a cascade of augmentations.

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

No branches or pull requests

2 participants