search

beetbox / pyacoustid

Python bindings for Chromaprint acoustic fingerprinting and the Acoustid Web service
MIT License
330 stars 66 forks source link

[enhancement] Improves python docstring for chromaprint #69

Closed aquaflamingo closed 2 years ago

aquaflamingo commented 2 years ago

Adds additional docstring information for the chromaprint python file.

This information originates from the chromaprint documentation site that you can generate when built from source.

sampsyo commented 2 years ago

Thanks for getting this started!

Since this adds direct descriptions of the arguments and return types, maybe it would be a good idea to follow a standard Python documentation style in Sphinx/ReST? The Google style guide is a good place to start.

I'm also not sure we need to say "decode_fingerprint calls decode_fingerprint"; we can just directly say what the function does.

aquaflamingo commented 2 years ago

Sure thing - just updated. Not super familiar with python docs string so feedback appreciated :)

sampsyo commented 2 years ago

Looks great! I tweaked them a bit for consistency and concision. Thanks for your help with this!!