On Sun, May 24, 2009 at 2:29 PM, Ralf Gommers <[email protected]> wrote: > 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.
it looks like this is already the case, the htmlhelp and the sphinx generated docs http://docs.scipy.org/doc/numpy/reference/generated/numpy.r_.html#numpy.r_ show the docstring that I get with help(np.r_) for RClass on the python prompt, even though in the doc editor it is empty. So editing RClass seems to be the right thing to do. Josef >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 > > > _______________________________________________ > Numpy-discussion mailing list > [email protected] > http://mail.scipy.org/mailman/listinfo/numpy-discussion > > _______________________________________________ Numpy-discussion mailing list [email protected] http://mail.scipy.org/mailman/listinfo/numpy-discussion
