Re: [matplotlib-devel] future of mpl documentation

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

On Friday 23 May 2008 04:34:11 pm John Hunter wrote:
> On Fri, May 23, 2008 at 3:31 PM, Darren Dale <dar...@co...> 
wrote:
> > commit yout customizing.txt?
>
> done.
>
> I just discovered l
>
>
>     # The name of an image file (within the static path) to place at the
> top of # the sidebar.
>     #html_logo = 'logo.png'
>
> so I have to get to work creating a new cool mpl figure for the logo.
> Our old banner is so 70s.

I wasn't going to say it... but yeah. :)

I think we need to set a policy on how we are going to handle code in 
docstrings. There are lots of places where indentation and asterisks are 
causing trouble. Should examples be codeblocks (::) or doctests (>>>)? I 
think inlines should just be `` quoted, like:

data are plotted as ``plot(lags, c, **kwargs)``

Here is an example from axes.Axes:

def xcorr(self, x, y, normed=False, detrend=mlab.detrend_none,        
    usevlines=False, maxlags=None, **kwargs):
    """
    XCORR(x, y, normed=False, detrend=mlab.detrend_none, usevlines=False, 
        **kwargs):a 

Can we eliminate the call signature? I think this is only necessary for 
extension code, the call signature will already be displayed by sphinx and by 
pythons interactive help.


Regarding the crazy pyplot error, I'm doing it the slow, painful way, 
including a few members at a time in the members list and fixing the errors 
that arise.

Darren