[Numpy-discussion] Why is numpy.ma.extras.clump_masked() not in main documentation?

Ralf Gommers ralf.gommers at gmail.com
Sun Dec 28 15:08:14 EST 2014


On Sun, Dec 28, 2014 at 9:04 PM, Ralf Gommers <ralf.gommers at gmail.com>
wrote:

>
>
>
> On Sun, Dec 28, 2014 at 8:48 PM, Yuxiang Wang <yw5aj at virginia.edu> wrote:
>
>> Dear all,
>>
>> I am really glad to find out a very useful function called
>> numpy.ma.extras.clump_masked(), and it is indeed well documented if
>> you look into the source. However, may I ask why does it not show up
>> in the main documentation website
>> (http://docs.scipy.org/doc/numpy/reference/routines.ma.html)?
>>
>
> Because they (there's also clump_unmasked) weren't added to the function
> list in doc/source/reference/routines.ma.rst. Care to send a PR for that?
>
> Other todo there is to fix up the examples, they should be used as
> np.ma.clump_masked not np.ma.extras.clump_masked.
>

Also, if anyone is in the mood to tackle this kind of thing in a more
structural way, it would be quite useful to adapt
https://github.com/scipy/scipy/blob/master/tools/refguide_check.py to numpy
and use it to find all missing functions.

Ralf
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/numpy-discussion/attachments/20141228/dcd8ecb8/attachment.html>


More information about the NumPy-Discussion mailing list