On Wed, Apr 29, 2009 at 2:55 AM, Gökhan SEVER <gokhanse...@gmail.com> wrote:
>
> I would like discuss these point before start working on other api
> functions and classes. Also need some explanation about them, since
> pyplot is composed of functions but some other api's are mixed with
> classes and functions.
>
> Please, contact me of the list so I can send the modified pyploy_rst.api.
Hey Gökhan -- thanks for working on this. We are very happy to have
documentation contributions. I don't feel strongly about how the pyplot rst
file is generated, whether by extending Sphinx, using a script, or simply
hand editing it. I'm actually incline toward the latter, because it would
probably be nice to have some simple description in the section header, eg::
acorr - autocorrelation plots
=====================
as we do on the main page. Part of the sphinx philosophy is that "hand
edited" documentation cannot be fully replaced by autogenerated
documentaiton, and this may be a reasonable place to do some hand editing.
If you go this route, update the pyplot module, the developer's guide and
the boilerplate.py script (it lives besides setup.py and is a script to
generate part of pyplot) so that when developers add a new function to
pyplot they know to update the api docs as well.
You may want to move further discussion over to the developers list. Any
changes you want to make should be posted as an svn diff to the developers
list. If you don't get immediate attention, also post it as a patch to the
sourceforge site, and reply to the developers list with a link to the patch
-- see
http://matplotlib.sourceforge.net/faq/howto_faq.html#contributing-howto
Thanks!
JDH
------------------------------------------------------------------------------
Register Now & Save for Velocity, the Web Performance & Operations
Conference from O'Reilly Media. Velocity features a full day of
expert-led, hands-on workshops and two days of sessions from industry
leaders in dedicated Performance & Operations tracks. Use code vel09scf
and Save an extra 15% before 5/3. http://p.sf.net/sfu/velocityconf
_______________________________________________
Matplotlib-users mailing list
Matplotlib-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/matplotlib-users
