[Numpy-discussion] Improving Docs on Wiki
dieter h
vel.accel@gmail....
Fri Mar 21 08:09:47 CDT 2008
On Fri, Mar 21, 2008 at 8:54 AM, Sebastian Haase <haase@msg.ucsf.edu> wrote:
> read relow...
> > NumpyDocstrings category on the wiki, and suggest that we organise the
> > functions underneath it according to their numpy subpackage, e.g.
> >
> > scipy.org/NumpyDocstrings/core/sort
> >
> > If you need to know where a function belongs, use IPython's "?" to inspect it:
> >
> > In [4]: np.core.sort?
> > [...]
> > File:
> > /Users/stefan/lib/python2.5/site-packages/numpy/core/fromnumeric.py
> > [...]
> >
>
> Comment: I have read the module- or directory-name "core" many times
> on this list, however: Who really knows where a given functions
> belongs ? Isn't that mostly only the numpy svn commiters ?
> In other words, using only the python side of numpy, someone (like
> myself) would NOT know that sort is inside "core" !
>
> Also: since >>> import numpy as N; N.sort refers already to that same sort:
> >>> N.core.sort
> <function sort at 0x01BACB30>
> >>> N.sort
> <function sort at 0x01BACB30>
>
> I would prefer not to require "core" sub-sub-page.
> Instead, every name <X> that is accessible as N.<X> should be
> documented without extra sub-page.
>
> My 2 cents.
> Thanks,
> Sebastian
Thats just a for placement. We can create all sorts of direct indexes,
categories and cross-references, etc...
-dieter
_______________________________________________
> Numpy-discussion mailing list
> Numpy-discussion@scipy.org
> http://projects.scipy.org/mailman/listinfo/numpy-discussion
>
More information about the Numpy-discussion
mailing list