Skip to content

Commit

Permalink
Change gaussian_pdf's docstring
Browse files Browse the repository at this point in the history
gaussian_pdf grew an extra argument (mean) but the docstring was not updated.

I also said that the mean should be in the interval [0, 180), but I'm not 100% that's true.
  • Loading branch information
codypiersall committed Nov 30, 2015
1 parent ba86d5c commit 0f25211
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions pytmatrix/orientation.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,9 @@ def gaussian_pdf(std=10.0, mean=0.0):
"""Gaussian PDF for orientation averaging.
Args:
std: The standard deviation of the PDF (the mean is always taken to
be 0).
std: The standard deviation in degrees of the Gaussian PDF
mean: The mean in degrees of the Gaussian PDF. This should be a number
in the interval [0, 180)
Returns:
pdf(x), a function that returns the value of the spherical Jacobian-
Expand Down

0 comments on commit 0f25211

Please sign in to comment.