[SciPy-dev] docstrings in class.__init__

josef.pktd@gmai... josef.pktd@gmai...
Thu May 7 10:08:03 CDT 2009


On Thu, May 7, 2009 at 11:02 AM,  <josef.pktd@gmail.com> wrote:
> 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.
>

or can we use

.. autoclass:: Noodle
   :members: eat, slurp

in the automatic summary

Josef


More information about the Scipy-dev mailing list