[Scipy-tickets] [SciPy] #1833: Some interpolate __init__ methods do not appear in documentation

SciPy Trac scipy-tickets@scipy....
Thu Jan 31 15:44:34 CST 2013


#1833: Some interpolate __init__ methods do not appear in documentation
---------------------------+------------------------------------------------
 Reporter:  capnrefsmmat   |       Owner:  pv         
     Type:  defect         |      Status:  new        
 Priority:  normal         |   Milestone:  Unscheduled
Component:  Documentation  |     Version:  0.11.0     
 Keywords:                 |  
---------------------------+------------------------------------------------
 For instance, for the Krogh interpolator:

 http://docs.scipy.org/doc/scipy-
 dev/reference/generated/scipy.interpolate.KroghInterpolator.html#scipy.interpolate.KroghInterpolator

 There is a well-documented {{{__init__}}} method in the source:

 https://github.com/scipy/scipy/blob/master/scipy/interpolate/polyint.py#L47

 However, the {{{__init__}}} method does not appear in the Sphinx
 documentation. Similarly, the {{{PiecewisePolynomial}}} documentation does
 not include any information at all on how to initialize the object,
 because the {{{__init__}}} docstring does not appear.

 This also appears to be the case for the {{{BarycentricInterpolator}}}.
 Many others include the {{{__init__}}} documentation in the class's
 docstring, which fixes the issue.

 I can submit a patch moving the {{{__init__}}} information to the class
 docstring if I get time.

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


More information about the Scipy-tickets mailing list