Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Some interpolate __init__ methods do not appear in documentation (Trac #1833) #2352

Closed
scipy-gitbot opened this Issue · 4 comments

1 participant

@scipy-gitbot

Original ticket http://projects.scipy.org/scipy/ticket/1833 on 2013-01-31 by trac user capnrefsmmat, assigned to @pv.

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.

@scipy-gitbot

@rgommers wrote on 2013-02-02

A patch moving content from the __init__ to the class docstring sounds good.

@scipy-gitbot

trac user capnrefsmmat wrote on 2013-02-02

I've submitted the patch as a pull request:

#411

@scipy-gitbot

@rgommers wrote on 2013-02-14

PR was merged.

@scipy-gitbot

Milestone changed to 0.12.0 by @rgommers on 2013-02-14

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.