-
-
Notifications
You must be signed in to change notification settings - Fork 2k
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
Updated documentation of stats.summary #2059
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well done :)
We'll merge this in when it passes. Welcome @denadai2 ! |
pymc3/stats.py
Outdated
""" | ||
"""Sample autocovariance at specified lag. | ||
|
||
Parameters |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
De-indent.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should still be fixed.
pymc3/stats.py
Outdated
x[:-lag] and x[lag:] in the diagonal and the autocovariance | ||
on the off-diagonal. | ||
""" | ||
"""Sample autocovariance at specified lag. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
line break to have """ on a single line.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you want to have
"""
Sample autocovariance at specified lag.
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As far as I see documentation should be """Comment
ref: http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're right, let's leave this.
It should be ok now :)) |
Nothing special, I enhanced the documentation :)