You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
justinsalamon
changed the title
Docstrings missing information for output parameters
[JOSS review] Docstrings missing information for output parameters
May 28, 2020
The docstrings are missing information about what the augmentation functions actually return.
For example, the docs for fade_in_and_out say:
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.
The text was updated successfully, but these errors were encountered: