[SciPy-dev] chararray docstrings

[josef.pktd at gmail.com]

On Tue, Oct 13, 2009 at 11:45 AM, Ralf Gommers
<ralf.gommers at googlemail.com> wrote:
>
>
> On Tue, Oct 13, 2009 at 5:23 PM, 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 methods are all there, you see them when you click on the chararray
> class in the link above. see
> http://docs.scipy.org/numpy/docs/numpy.core.defchararray.chararray/
>>
>> The "Review status" is stuck on "Unimportant".  Not sure what that means.
>
> Each item has a review status. You were looking at the module docstring. You
> can see that the class docstring is at "Needs Review"  and most methods in
> the writing/needs review stage as well.
>
> I don't see the new functions you added yet, not sure why.
>
> All docs in the wiki are visible on this page:
> http://docs.scipy.org/numpy/docs/ I usually search there for what I need.
>>
>> 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 them now. Maybe something odd was going on with merging in your
> changes, I had to click "accept merge" on the Merge page.
>
> Cheers,
> Ralf
>
>>
>> Pardon my ignorance -- just trying to mark the new docstrings as "needs
>> review".
>>
>> 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
>
>

How are the new string functions imported from python? How are they exposed?

I think the doc editor only picks up functions that are exposed in an __all__
and maybe also from a module that doesn't have an __all__

cross linking should work once the doc editor is able to pick up the
functions in
http://docs.scipy.org/numpy/docs/numpy-docs/reference/routines.char.rst/

That's my impression of the doc editor so far.

Josef