Re: [matplotlib-devel] doc warnings

[John H. <jd...@gm...>]

On Fri, Jul 25, 2008 at 2:48 AM, David Kaplan <Dav...@ir...> wrote:
> Hi,
>
> On Thu, 2008-07-24 at 13:08 -0700,
> mat...@li... wrote:
>> WARNING: /home/jdhunter/dev/lib64/python2.5/site-packages/matplotlib/axes.py:docstring
>> of matplotlib.axes.Axes.acorr:36: (ERROR/3) Unexpected indentation.
>> WARNING: <autodoc>:0: (ERROR/3) Unexpected indentation.
>> WARNING: /home/jdhunter/dev/lib64/python2.5/site-packages/matplotlib/backend_bases.py:docstring
>> of
>> matplotlib.backend_bases.FigureCanvasBase.start_event_loop_default:15:
>> (WARNING/2) Literal block expected; none found.
>>
>
> I looked at my doc strings and as far as I can tell, they are identical
> in format to other functions around them.  What does this error mean?

The problem is after the double colon in the following block::

        This function provides default event loop functionality based
        on time.sleep that is meant to be used until event loop
        functions for each of the GUI backends can be written.  As
        such, it throws a deprecated warning.

        Call signature::

        start_event_loop_default(self,timeout=0)

you need to indent relative to the line containing the double colon, eg::

        Call signature::

            start_event_loop_default(self,timeout=0)

        This call blocks until a callback function triggers
        stop_event_loop() or *timeout* is reached.  If *timeout* is
        <=0, never timeout.

I went ahead and committed this change.
JDH