[JOSS review] Docstrings missing information for output parameters

[justinsalamon]

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.

[bmcfee]

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