On Fri, Jul 25, 2008 at 10:09 AM, John Hunter <jdh2358@...> wrote:
> The problem is after the double colon in the following block::
David, I cleaned up a few more of these warnings. I notice on most of
the functions you added to cbook, you added call signature lines, in
many cases where they are not needed. I want to try and clarify where
they are needed. If your function uses *args or **kwargs that pass
through, you want to give the user some idea what those are. This is
most important in pylab, which pass the args and kwargs through to the
equivalent Axes method. Since the pylab docstring just reads *args,
**kwargs, we use the Axes method of the same name to show the call
signature. In general, you do not need to add these, especially if
your function declaration explicitly lists the args and keyword args,
so I have removed most of these.
Also, I would rather not put the geometry functions in cbook, eg
distances_along_curve and path_length and friends. Perhaps we should
have some sort of geometry module where all these things live (there
are some in mlab as well) but barring that I would rather have
math/geometry stuff in mlab and general purpose helpers in cbook.
Let's move all those before the release so we don't have to worry
about API breakage later.