PsychoinformaticsLab / pliers

Automated feature extraction in Python
https://pliers.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
296 stars 68 forks source link

args missing from MFCCEnergyExtractor docstring #462

Closed rbroc closed 3 years ago

rbroc commented 3 years ago

https://github.com/PsychoinformaticsLab/pliers/blob/fcae6d7b6a7360adde8e5d840e920cb3b33e2e7d/pliers/extractors/audio.py#L624-L642 Some arguments to __init__ are not part of the docstring and should be added. Given the complexity of the extractor, the description should also be made clearer (e.g., adding reference to where the algorithm comes from and how to set parameters?)