[Scipy-tickets] [SciPy] #594: docstring in scipy.stats.kurtosis is wrong

SciPy scipy-tickets@scipy....
Fri Jan 25 21:06:12 CST 2008


#594: docstring in scipy.stats.kurtosis is wrong
-------------------------+--------------------------------------------------
 Reporter:  ctw          |       Owner:  somebody
     Type:  defect       |      Status:  new     
 Priority:  normal       |   Milestone:  0.7     
Component:  scipy.stats  |     Version:          
 Severity:  trivial      |    Keywords:          
-------------------------+--------------------------------------------------
 The docstring for scipy.stats.kurtosis states:


 {{{
 Returns
 -------
 The kurtosis of values along an axis, returning 0 where all values are
 equal.

 }}}

 However, with the default setting (i.e., fisher=True) the function returns
 -3 when all values are equal. I suggest updating this part of the
 docstring to read:


 {{{
 Returns
 -------
 The kurtosis of values along an axis, returning -3 (for Fisher's
 defenition) or 0 (for Pearson's definition) where all values are equal.

 }}}

-- 
Ticket URL: <http://scipy.org/scipy/scipy/ticket/594>
SciPy <http://www.scipy.org/>
SciPy is open-source software for mathematics, science, and engineering.


More information about the Scipy-tickets mailing list