search

carlthome / python-audio-effects

Apply audio effects such as reverb and EQ directly to audio files or NumPy ndarrays.
MIT License
381 stars 52 forks source link

Pull-request: Add doc strings to most effects that lacked them. #21

Closed rudytrubitt closed 5 years ago

rudytrubitt commented 5 years ago

I've added docstrings to most of the effects. I did not include them for a couple effects such as bend , where the required input syntax from the user was unclear to me. I'd be happy to complete the remaining implemented effects if I could get a few usage examples.

carlthome commented 5 years ago

Great! Thanks for your help. Could you run docformatter to ensure a consistent formatting before merging?

rudytrubitt commented 5 years ago

Hello Carl,

Yes, I can run docformatter and will update my pull request once I’ve done so.

Cheers, Rudy

On Nov 20, 2018, at 9:52 AM, Carl Thomé notifications@github.com wrote:

Great! Thanks for your help. Could you run docformatter to ensure a consistent formatting https://pypi.org/project/docformatter/ https://pypi.org/project/docformatter/ before merging?

https://github.com/myint/docformatter#wrapping-descriptions https://github.com/myint/docformatter#wrapping-descriptions — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/carlthome/python-audio-effects/pull/21#issuecomment-440369961, or mute the thread https://github.com/notifications/unsubscribe-auth/Ao1WP2YbmCUiEwYKfnGgKLvcdEvz_qdLks5uxEFAgaJpZM4YeOjm.

rudytrubitt commented 5 years ago

Hello Carl,

I’ve run docformater on my changes and updated my repo at (https://github.com/rudytrubitt/python-audio-effects.git).

Initially I thought I’d create a new pull request, but now I’m thinking that’s not necessary. I do see there are changes to master so that a merge is necessary. Let me know if you need anything else from me on this topic.

During the process of creating the documentation, I made a new python file which includes an example of each effect I documented. When run, this file takes the same dry sound file and applies each effect, then writes a new audio file with the effect type appended to the that filename. I can assemble this into a new repo and will let you know when it’s done, perhaps this might be a useful addition to the package.

Cheers rudy

On Nov 24, 2018, at 10:18 AM, Rudy Trubitt rudy@trubitt.com wrote:

Hello Carl,

Yes, I can run docformatter and will update my pull request once I’ve done so.

Cheers, Rudy

On Nov 20, 2018, at 9:52 AM, Carl Thomé <notifications@github.com mailto:notifications@github.com> wrote:

Great! Thanks for your help. Could you run docformatter to ensure a consistent formatting https://pypi.org/project/docformatter/ https://pypi.org/project/docformatter/ before merging?

https://github.com/myint/docformatter#wrapping-descriptions https://github.com/myint/docformatter#wrapping-descriptions — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/carlthome/python-audio-effects/pull/21#issuecomment-440369961, or mute the thread https://github.com/notifications/unsubscribe-auth/Ao1WP2YbmCUiEwYKfnGgKLvcdEvz_qdLks5uxEFAgaJpZM4YeOjm.

carlthome commented 5 years ago

Thanks for contributing! 🥇

I made a new python file which includes an example of each effect I documented. When run, this file takes the same dry sound file and applies each effect, then writes a new audio file with the effect type appended to the that filename.

This might be useful as an examples/effects.py in the root directory, as long as we run it in .travis.yml to make sure it keeps working.