[SciPy-dev] chararray docstrings

[Ralf Gommers]

On Tue, Oct 13, 2009 at 6:06 PM, Michael Droettboom <mdroe at 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?
>

If the object is already in the wiki, you can just edit its page, copy in
your changes and click preview to check. For new objects, I guess you would
have to run the whole wiki on your own computer to try - a bit too much
trouble maybe.

>
> 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?
>

>From the changes I saw, it should indeed work once the functions show up.

The way it works is that first the current module is searched for an object
with the name of the cross-ref you gave, if it is not found then it goes up
the chain of modules. If the object you reference from for example
numpy.mais in `ma` or in `numpy` it will be found, but if it is in
`numpy.fft` you
reference it as `fft.yourref`.


> Also -- How can I change a review status from "Unimportant"?
>
> One of the admins has to give you reviewer permissions.

Please leave private objects at Unimportant though - besides indicating what
needs review the status is also used to guide contributors to the most
important docstrings to be done. Stuff only relevant to devs can sometimes
be marked Unimportant; that does not mean those docs can't also be improved.


Cheers,
Ralf



> Mike
>
> josef.pktd at gmail.com wrote:
> > On Tue, Oct 13, 2009 at 11:47 AM, Michael Droettboom <mdroe at stsci.edu>
> wrote:
> >
> >> josef.pktd at gmail.com wrote:
> >>
> >>> On Tue, Oct 13, 2009 at 11:23 AM, Michael Droettboom <mdroe at stsci.edu>
> wrote:
> >>>
> >>>
> >>>> Ralf Gommers wrote:
> >>>>
> >>>>
> >>>>> On Mon, Oct 12, 2009 at 5:40 PM, Michael Droettboom <mdroe at stsci.edu
> >>>>> <mailto:mdroe at 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 at scipy.org
> >> http://mail.scipy.org/mailman/listinfo/scipy-dev
> >>
> >>
> > _______________________________________________
> > Scipy-dev mailing list
> > Scipy-dev at 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 at scipy.org
> http://mail.scipy.org/mailman/listinfo/scipy-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/scipy-dev/attachments/20091013/a4b311a9/attachment.html>