[Numpy-discussion] Unifying numpy, scipy, and matplotlib docstring formats

[David Huard]

To get back to the original subject of the thread, there has been a commit
today on the docutils plugins branch that allows folks to write their own
parser/writer and somehow include it in docutils, without having to rebuild
docutils. In other words, NumPy could define a plugin, and if docutils is
installed, link the plugin to the docutils installation. This would allow
third party package that use docutils to process numpy docstrings using the
plugin. I don't know how far we can disgress from the reST syntax using
those plugins, but it's probably something worth looking at.

Check out:
svn://svn.berlios.de/docutils/branches/plugins

and the info about the plugin hookup is in docs/howto/extensions.txt

David

2007/2/27, Alexandre Fayolle <alexandre.fayolle at logilab.fr>:
>
> On Sun, Feb 25, 2007 at 06:44:37PM +0200, Jouni K. Seppänen wrote:
> > "Barry Wark" <barrywark at gmail.com> writes:
> >
> > > Yes, I agree. I wasn't coming at so much from the goal of making Pylab
> > > a Matlab clone (as you point out, that's silly, and misses much of the
> > > advantage of Python), but rather from the goal of making interactive
> > > use as efficient as possible. When I fire up ipython -pylab to do some
> > > quick exploration, it's nice not to have to type N.blah or pylab.plot
> >
> > IMHO the greatest strength of Matlab in interactive use is the matrix
> > input format. For one thing, it is easier to type something like
> >
> >   [0 1 0; 1 0 0; 0 0 1]
> >
> > than
> >
> >   array([[0,1,0],[1,0,0],[0,0,1]])
>
>
> A very nice shortcut in my opinion is the one supported by the HP
> scientific calculators (HP28, HP48 in my days), which would look like:
>
> array([[0,1,0], 1, 0, 0, 0, 0, 1])
>
> I'm not quite sure how this could be generalized nicely for arbitrary
> shapes, but for arrays of rank 2 (which are a very common case where
> people are actually typing the values) it feels nice (especially on a
> french keyboard where the square brackets are awkward to type in)
>
> --
> Alexandre Fayolle                              LOGILAB, Paris (France)
> Formations Python, Zope, Plone, Debian:  http://www.logilab.fr/formations
> Développement logiciel sur mesure:       http://www.logilab.fr/services
> Informatique scientifique:               http://www.logilab.fr/science
> Reprise et maintenance de sites CPS:     http://www.migration-cms.com/
>
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v1.4.6 (GNU/Linux)
>
> iQEVAwUBReP+816T+PKoJ87eAQITUQf/bVo3QH6hZV/kM71v89WzMODMeZb8IxXs
> BwoSSuL5YZGETKiR9wMmAcqVceJ6P0sW/5slWlJjXAONDfvcdTFkFaV1tyC2gWbP
> tTJu4kLe8BX7y/UsCM1y2U90GGI/LbYVAjMa+4HdWdsMoBTRN4tyeEuq/3Upg/rN
> GWW7+X+1poO1ZtjWDOpVS1DcZeioiYtsXvU0zAKe+briPM1QnIc1K2zfkwUBhA7F
> L7osi3uq+muucKE/sEpBQ9SotLbfJ+yFIZOYBSDiFPCSJi9bE6KvKVm+EfXt23KY
> 09dOd3rx+H471Pv90uzAVULLDUXucU/tKLBxVHhzMu6rzdb297QmfA==
> =1RL1
> -----END PGP SIGNATURE-----
>
> _______________________________________________
> Numpy-discussion mailing list
> Numpy-discussion at scipy.org
> http://projects.scipy.org/mailman/listinfo/numpy-discussion
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/numpy-discussion/attachments/20070302/6ea09fe6/attachment.html>