Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add advanced usage section to docs #45

Open
4 tasks
rabitt opened this issue Mar 12, 2017 · 4 comments
Open
4 tasks

Add advanced usage section to docs #45

rabitt opened this issue Mar 12, 2017 · 4 comments

Comments

@rabitt
Copy link
Collaborator

rabitt commented Mar 12, 2017

Include usage of:

  • noiseprof / noisered
  • stat
  • stats
  • power_spectrum
@Page-David
Copy link
Contributor

If I am right, I do not think stats should be added into advanced usage, this is just get some basic information of a audio file.

@rabitt
Copy link
Collaborator Author

rabitt commented Mar 19, 2017

@Page-David I'd like stat and stats to be part of the "advanced usage" not because what they do is particularly complex, but because the methods behave differently than the rest of the Transformer methods. The "normal" Transformer methods like fade or silence are audio effects that applied when build is called. stat, however, doesn't affect the processing chain and instead simply returns information.

@Page-David
Copy link
Contributor

I feel it likes to cause some misunderstanding as transform.stat looks like file_info.stat.

And doc List of frequency (Hz), amplitdue pairs. in transform.stats:

amplitdue->amplitude?

@rabitt
Copy link
Collaborator Author

rabitt commented Apr 1, 2017

I feel it likes to cause some misunderstanding as transform.stat looks like file_info.stat.

Yes good point. I've opened #46 to address this.

And doc List of frequency (Hz), amplitdue pairs. in transform.stats

yep there's a typo

lostanlen added a commit to lostanlen/pysox that referenced this issue Jul 25, 2018
Addresses a comment in issue marl#45
marl#45 (comment)
Update `transform.power_spectrum` and `transform.stats` docstrings
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants