Merge pull request #5527 from efiring/rayleigh_docstring

charris · charris · commit a02f5c8fd384 · 2015-01-30T22:49:01.000-05:00
DOC: correct erroneous description of Rayleigh distribution
diff --git a/numpy/random/mtrand/mtrand.pyx b/numpy/random/mtrand/mtrand.pyx
@@ -3324,10 +3324,10 @@ cdef class RandomState:
 
         .. math:: P(x;scale) = \\frac{x}{scale^2}e^{\\frac{-x^2}{2 \\cdotp scale^2}}
 
-        The Rayleigh distribution arises if the wind speed and wind direction are
-        both gaussian variables, then the vector wind velocity forms a Rayleigh
-        distribution. The Rayleigh distribution is used to model the expected
-        output from wind turbines.
+        The Rayleigh distribution would arise, for example, if the East
+        and North components of the wind velocity had identical zero-mean
+        Gaussian distributions.  Then the wind speed would have a Rayleigh
+        distribution.
 
         References
         ----------
