[Scipy-tickets] [SciPy] #761: __doc__ for stats.distribution: changeset:4681 removed individualized docs

SciPy scipy-tickets@scipy....
Mon Oct 27 07:57:51 CDT 2008


#761: __doc__ for stats.distribution: changeset:4681 removed individualized docs
-------------------------+--------------------------------------------------
 Reporter:  josefpktd    |       Owner:  somebody
     Type:  defect       |      Status:  new     
 Priority:  normal       |   Milestone:  0.7.0   
Component:  scipy.stats  |     Version:          
 Severity:  normal       |    Keywords:          
-------------------------+--------------------------------------------------
 originally reported in http://projects.scipy.org/pipermail/scipy-
 dev/2008-October/009829.html by Per Brodtkorb:

 When I import scipy.stats.distributions into ipython, the doc-strings for
 the distributions are not updated correctly.

 Also new scipy docs don't show individualized doc strings as a
 consequence: http://docs.scipy.org/doc/scipy/reference/stats.html
 #continuous-distributions

 There was an incorrect change in changeset:4681 which removed the
 adjustment of `__doc__` to the individual distribution functions.


 Fix: replace this part in `__init__` method of rv_discrete and
 rv_continous class:
 (i.e. revert this part of changeset:4681), e.g for discrete:

 {{{
 if self.__doc__ is None:
         self.__doc__ = rv_discrete.__doc__
 else:
         self.__doc__ = self.__doc__.replace("A Generic",longname)
 }}}

 with

 {{{
 if self.__doc__ is None:
         self.__doc__ = rv_discrete.__doc__
 if self.__doc__ is not None:
         self.__doc__ = self.__doc__.replace("A Generic",longname)
 }}}


 Josef

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


More information about the Scipy-tickets mailing list