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

Documentation issue with stats.lognorm.fit() #12224

Closed
DrBwts opened this issue May 26, 2020 · 1 comment
Closed

Documentation issue with stats.lognorm.fit() #12224

DrBwts opened this issue May 26, 2020 · 1 comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.stats

Comments

@DrBwts
Copy link

DrBwts commented May 26, 2020

stats.lognorm is an instance of stats.rv_continuous yet the documetation on the fit method are at odds with each other.

From stats.lognorm docs,

fit(data, s, loc=0, scale=1)

From stats.rv_continuous docs,

fit(self, data, *args, **kwds)

Note this difference in listed arguments. If you try to use the method using the arguments from the lognorm docs then an error is thrown.

This issue was brought to light in this Stackoverflow question.

@ev-br
Copy link
Member

ev-br commented May 26, 2020

Looks like it has been fixed in the dev version:
http://scipy.github.io/devdocs/generated/scipy.stats.lognorm.html#scipy.stats.lognorm

EDIT: Indeed, it's gh-11897. I'll close this issue, but further improvements are most welcome. Please do send a PR with improvements!

@ev-br ev-br added scipy.stats Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org labels May 26, 2020
@ev-br ev-br closed this as completed May 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.stats
Projects
None yet
Development

No branches or pull requests

2 participants