[SciPy-user] Docstring standards for NumPy and SciPy

Alan G Isaac aisaac at american.edu
Thu Jan 18 13:39:44 CST 2007


On Thu, 18 Jan 2007, Travis Oliphant apparently wrote: 
> :math: 
> would be an equation that does not necessarily use latex syntax for 
> math.  Several markup languages define math so that for example 
> :math:`y=f(x)` renders differently. 

I think I understand:
the intent is essentially to allow *styling*
of a particular span or div, without support
for any "type-setting" commands. Is that right?

So, for example, if someone wants to use Lout
notation, they can for now just use a math role
(to get, e.g., fix width italic rendering)
but at some future date if reST supports a
`lout-math` role, they could change over to
this role while making no other changes.
This seems generously open-ended.

Thanks,
Alan






More information about the SciPy-user mailing list