-
Notifications
You must be signed in to change notification settings - Fork 74
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
Request: Documentation #94
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Your kneedle algorithm implementation work pretty good for me, thank you very much!
Just one minor issue: The package itself lacks of some documentation. What I have been looking for:
General documentation for "kneed" module, unfortunately there is no docstring for the "kneed" package once imported:
Docstring: <no docstring>
I am missing here a full documentation for the functions and methods provided just by looking into the module's offline documentation
Finding the "best" sensitivity parameter is documented here, but I think the statement "S is a measure of how many “flat” points we expect to see in the unmodified data curve before declaring a knee." needs to be represented in the docstring for
kneed.KneeLocator()
as well. Currently it's just:ivar S: Sensitivity, original paper suggests default of 1.0
In my honest opinion, the parameters information in the docstring currently is a little confusing to be honest. I think it would be good if parameter names, descriptions and accepted data types could be cleaned up a little to a more easier-to-read format just like docstrings in
numpy
orpandas
. For example:to
Kind regards,
DK
The text was updated successfully, but these errors were encountered: