Re: [matplotlib-devel] future of mpl documentation

[Darren D. <dar...@co...>]

On Friday 23 May 2008 6:06:30 pm Eric Firing wrote:
> >     xcorr(*args, **kwargs)
> >         XCORR(x, y, normed=False, detrend=mlab.detrend_none,
> > usevlines=False, **kwargs):
>
> Sorry I'm not helping yet, but while you are in the middle of all this,
> please ditch the ugly and misleading Matlab-style capitalization of the
> function names.
>
> Thanks for all the work and amazing progress.

Some of these docstrings are *really* hard to trace. Where does pyplot.arrow 
get its docstring? It looks like it comes from axes.arrow, which gets a bit 
from patches.FancyArrow, which gets a bit from patches.Patch, which gets a 
bit from artist.kwdocd['Patch'] at the top of patches.py. However, I have 
completely rewritten artist.kwdocd['Patch']:

artist.kwdocd['Patch'] = """

        =================   ==============================================
        Property            Description
        =================   ==============================================
        alpha               float
        animated            [True | False]
        antialiased or aa   [True | False]
        clip_box            a matplotlib.transform.Bbox instance
        clip_on             [True | False]
        edgecolor or ec     any matplotlib color
        facecolor or fc     any matplotlib color
        figure              a matplotlib.figure.Figure instance
        fill                [True | False]
        hatch               unknown
        label               any string
        linewidth or lw     float
        lod                 [True | False]
        transform           a matplotlib.transform transformation instance
        visible             [True | False]
        zorder              any number
        =================   ==============================================

        """

but the change has not propagated up to pyplot.arrow.

I have to break here for the weekend, I'll be back monday afternoon. Leave 
some for me! (although I'll owe doughnut to whoever can fix the arrow 
docstring).

Darren