[SciPy-dev] doc question: special.orthogonal.p_roots and co

[David Goldsmith]

On Sun, Dec 6, 2009 at 1:43 PM, <josef.pktd at gmail.com> wrote:

> On Sun, Dec 6, 2009 at 3:59 PM, Ralf Gommers
> <ralf.gommers at googlemail.com> wrote:
> >
> >
> > On Sun, Dec 6, 2009 at 5:46 PM, <josef.pktd at gmail.com> wrote:
> >>
> >> I was looking for the Legendre points and weights for Gaussian
> quadrature.
> >> In the source of integrate.quadrature, I found the use of
> >> special.orthogonal.p_roots
> >> It is not in my (oldish) htmlhelp
> >>
> >> p_roots and co are not links in
> >>
> >> http://docs.scipy.org/scipy/docs/scipy.special.orthogonal/
> >>
> >> on the doc page for them, they show up as
> >> Note: This docstring is obsolete; the corresponding object is no
> >> longer present in SVN.
> >>
> >> http://docs.scipy.org/scipy/docs/scipy.special.orthogonal.p_roots/
> >>
> >> in trunk they are still available:
> >>
> >>
> http://projects.scipy.org/scipy/browser/trunk/scipy/special/orthogonal.py#L602
> >>
> >> Is this a documentation bug, or are there some changes that I didn't
> see?
> >
> > In rev 6070 Pauli added an __all__ dict to orthogonal.py that does not
> > include those functions. I think pydocweb only generates pages for
> objects
> > in __all__ if that exists. So it looks like that is the reason.
> >
> > Should all the xx_roots funcs be in __all__ in your opinion?
>
> I would think so, but I just saw them for the first time and found them
> only because I looked at the source of integrate.quadrature.
>
> Josef
>
> >
> > Cheers,
> > Ralf
>
>
Perhaps Pauli can comment on why he left them out...

DG
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/scipy-dev/attachments/20091206/2c57fd12/attachment.html>