[SciPy-dev] docstrings in class.__init__

josef.pktd at gmail.com josef.pktd at gmail.com
Thu May 7 11:02:25 EDT 2009


I just looked at the spline classes in scipy.interpolate.

The docstring for the constructor is in the __init__ method, however
this is currently not captured by the sphinx documentation.
example: http://docs.scipy.org/scipy/docs/scipy.interpolate.fitpack2.UnivariateSpline/#scipy-interpolate-univariatespline

Is it possible to automatically add the __init__ docstring to the
class docstring, or should we copy or move them over, or add __init__
method explicitly to the .rst files to be scanned by sphinx?

help(interpolate.LSQUnivariateSpline) doesn't have this problem, as
discussed last year.

Josef



More information about the SciPy-Dev mailing list