[SciPy-dev] are masked array statistical function hidden intentionally?

Pauli Virtanen pav@iki...
Wed Nov 19 03:07:13 CST 2008


Tue, 18 Nov 2008 19:04:01 -0500, josef.pktd wrote:
> On Tue, Nov 18, 2008 at 4:52 PM, Pierre GM <pgmdevlist@gmail.com> wrote:
>> About the documentation: well, I guess I should take the blame for not
>> having written more thorough docstrings.  However, I'm not in charge of
>> building the whole doc.
[clip]
> I thought it more as an "advertising" question, since the docs seem to
> pick up only functions that are exposed in __all__, also np.lookfor does
> not seem to pick up any of the functions.

The docs don't pick up functions automatically -- instead, each function 
is manually added to the docs, to a place that makes sense. This is the 
way Sphinx works, and IMHO it is the correct way -- only the developer 
knows what it supposed to be the API of a module and how to best describe 
it.

The Scipy docs live in the Scipy repository, under doc/. Please feel free 
to add whatever you think is missing there. Ditto for the numpy docs 
(they are also in Numpy's SVN, but under /numpy-docs/trunk).

Pierre -- the masked array documentation in Numpy Reference Guide is 
especially lacking as not all MA functions are listed or the 
functionality explained. I'm not so familiar with MA, so I would 
appreciate help in writing the documentation for this part of Numpy.

np.lookfor is a different beast, and it IIRC picks only items listed in 
__all__. I am the one to blame if the logic in it is incorrect, so please 
tell me if you have a better idea how it should work.

-- 
Pauli Virtanen



More information about the Scipy-dev mailing list