[SciPy-dev] chararray docstrings

David Goldsmith d.l.goldsmith@gmail....
Wed Oct 14 03:58:51 CDT 2009


Hi, Michael.  Say, when you get a chance, can you take a look at
http://docs.scipy.org/numpy/docs/numpy.core.defchararray?  I feel like, at
the very least, the Note should be either modified or deleted, but are there
any other changes to be made in light of the work you've done?

DG

On Tue, Oct 13, 2009 at 9:06 AM, Michael Droettboom <mdroe@stsci.edu> wrote:

> Ok -- I can add them to __all__ in defchararray.py.
>
> Is there a good way for me to check that my changes will work in the
> documentation editor?  I rebuilt the docs in the source tree (by going
> in to doc/ and running "make html") and these methods *were* picked up.
> How do other people work and test their changes?
>
> I also noticed that the cross-referencing from the chararray methods to
> the free functions in defchararray is broken in the online documentation
> editor.  Again, mostly just my ignorance of how all the pieces go
> together.  Can someone explain what it should be, and then I'll make all
> the necessary corrections?  E.g. what should the "See also" section of
> defchararray.chararray.isalnum look like to reference defchararray.isalnum?
>
> Also -- How can I change a review status from "Unimportant"?
>
> Mike
>
> josef.pktd@gmail.com wrote:
> > On Tue, Oct 13, 2009 at 11:47 AM, Michael Droettboom <mdroe@stsci.edu>
> wrote:
> >
> >> josef.pktd@gmail.com wrote:
> >>
> >>> On Tue, Oct 13, 2009 at 11:23 AM, Michael Droettboom <mdroe@stsci.edu>
> wrote:
> >>>
> >>>
> >>>> Ralf Gommers wrote:
> >>>>
> >>>>
> >>>>> On Mon, Oct 12, 2009 at 5:40 PM, Michael Droettboom <mdroe@stsci.edu
> >>>>> <mailto:mdroe@stsci.edu>> wrote:
> >>>>>
> >>>>>     I was able to make my big chararray commit today.  If I
> understand
> >>>>>     correctly, I need to wait 24 hours for the doc editor to sync
> with
> >>>>>     SVN,
> >>>>>     and then I should mark all the chararray-related docstrings as
> "needs
> >>>>>     review".
> >>>>>
> >>>>>
> >>>>>
> >>>> Ok -- I'm a bit lost in the documentation editor.
> >>>>
> >>>> I go to the defchararray module, and I don't see any of the new
> >>>> functions or old methods:
> >>>>
> >>>> http://docs.scipy.org/numpy/docs/numpy.core.defchararray
> >>>>
> >>>> The "Review status" is stuck on "Unimportant".  Not sure what that
> means.
> >>>>
> >>>> I go to the chararray class and I can't see any methods:
> >>>>
> >>>>
> >>>>
> >>>
> >>>> http://docs.scipy.org/numpy/docs/numpy.core.defchararray.chararray/
> >>>>
> >>>>
> >>> I see many  methods at the bottom of this page, I don't know the names
> >>> of the new methods to see whether they are there.
> >>>
> >>>
> >> Odd.  They weren't there a moment ago.  Sorry for the noise.
> >>
> >
> > I also found the new functions at
> >
> >
> http://docs.scipy.org/numpy/docs/numpy-docs/reference/routines.char.rst/#id4
> >
> > but the doc editor is not picking up the docstrings
> >
> > I think they are only picked up if they are in an __all__
> >
> > currently:    defchararray.__all__ = ['chararray']
> >
> > Josef
> >
> >
> >> Mike
> >>
> >> --
> >> Michael Droettboom
> >> Science Software Branch
> >> Operations and Engineering Division
> >> Space Telescope Science Institute
> >> Operated by AURA for NASA
> >>
> >> _______________________________________________
> >> Scipy-dev mailing list
> >> Scipy-dev@scipy.org
> >> http://mail.scipy.org/mailman/listinfo/scipy-dev
> >>
> >>
> > _______________________________________________
> > Scipy-dev mailing list
> > Scipy-dev@scipy.org
> > http://mail.scipy.org/mailman/listinfo/scipy-dev
> >
>
> --
> Michael Droettboom
> Science Software Branch
> Operations and Engineering Division
> Space Telescope Science Institute
> Operated by AURA for NASA
>
> _______________________________________________
> Scipy-dev mailing list
> Scipy-dev@scipy.org
> http://mail.scipy.org/mailman/listinfo/scipy-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/scipy-dev/attachments/20091014/a744cfa1/attachment.html 


More information about the Scipy-dev mailing list