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

Updated documentation of stats.summary #2059

Merged
merged 2 commits into from
Apr 24, 2017
Merged

Conversation

denadai2
Copy link
Contributor

Nothing special, I enhanced the documentation :)

Copy link
Contributor

@springcoil springcoil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well done :)

@springcoil
Copy link
Contributor

We'll merge this in when it passes. Welcome @denadai2 !

pymc3/stats.py Outdated
"""
"""Sample autocovariance at specified lag.

Parameters
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

De-indent.

Copy link
Member

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.
Copy link
Member

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.

Copy link
Contributor Author

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.

?

Copy link
Contributor Author

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

Copy link
Member

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.

@denadai2
Copy link
Contributor Author

It should be ok now :))

@twiecki twiecki merged commit 1dc2da0 into pymc-devs:master Apr 24, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants