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

Cite original literature #642

Closed
stefan-balke opened this issue Nov 6, 2017 · 3 comments
Closed

Cite original literature #642

stefan-balke opened this issue Nov 6, 2017 · 3 comments
Labels
documentation Issues relating to docstrings, examples, and documentation build good for beginners Are you new here? These issues are for you!

Comments

@stefan-balke
Copy link
Member

Hey,

it happened to me that I want to know more about a particular feature–what a surprise.
However, we are often missing citation to the original literature.
For instance, mel filters (https://github.com/librosa/librosa/blob/master/librosa/filters.py#L259), what or who is "Stanley"? Stanley Smith Stevens?
However, adding a literature remark would clarify this and also could document if we deviate with our implementation from that.

What do you think, worth the effort?

@bmcfee bmcfee added documentation Issues relating to docstrings, examples, and documentation build good for beginners Are you new here? These issues are for you! labels Nov 6, 2017
@bmcfee
Copy link
Member

bmcfee commented Nov 7, 2017

what or who is "Stanley"? Stanley Smith Stevens?

This guy

But yes, there should be a reference to the auditory toolbox in the docs there.

@lostanlen
Copy link
Contributor

I couldn't believe that this issue had been unresolved for five months so I wrote a piece of doc in mel_frequencies (PR #701) in an attempt to close it.

@lostanlen
Copy link
Contributor

lostanlen commented Apr 30, 2018

can we close this now that #701 is merged?

@bmcfee bmcfee closed this as completed Apr 30, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues relating to docstrings, examples, and documentation build good for beginners Are you new here? These issues are for you!
Development

No branches or pull requests

3 participants