[Numpy-discussion] documenting index_tricks

Ralf Gommers ralf.gommers@googlemail....
Sun May 24 13:29:30 CDT 2009


Hi all,

I'm documenting the index_tricks module and am unsure how to handle r_ and
related objects. r_ is an instance of RClass, therefore ipython shows the
RClass docstring for "r_?". RClass in the doc editor is also marked as
"needs editing", and the page for r_ is completely empty (see
http://docs.scipy.org/numpy/docs/numpy.r_/#numpy-r). It seems like only one
of the two should be edited and then the docstring should be copied over. In
Travis Oliphant's Guide to Numpy r_ is extensively documented, should I
integrate part of that with one of the docstrings?

About the code itself, is there a use case for having two RClass instances
at the same time? If not maybe RClass should be a private class. Also a name
like RowConcatenator (it is a subclass of AxisConcatenator) would make more
sense. I'm not sure this change is worth the trouble though.

Cheers,
Ralf
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/numpy-discussion/attachments/20090524/3c27ae62/attachment.html 


More information about the Numpy-discussion mailing list