[Numpy-discussion] Help!!! Docstrings overrun by markup crap.

Alan G Isaac aisaac@american....
Sat Mar 20 14:32:44 CDT 2010


On 3/20/2010 2:15 PM, josef.pktd@gmail.com wrote:
> As far as I know, stars are the only way to render a list in
> restructured txt, otherwise it looses the list formatting.

Try a definition list?
Example below.
Alan


Returns
-------

q, r if mode = 'full':
    - q : ndarray of float or complex, shape (M, K)
    - r : ndarray of float or complex, shape (K, N)

    K = min(M, N)

r if mode = 'r':
    - r : ndarray of float or complex, shape (K, N)

a2 if mode = 'economic':
    - a2 : ndarray of float or complex, shape (M, N)

    The diagonal and the upper triangle of a2 contains r,
    while the rest of the matrix is undefined.




More information about the NumPy-Discussion mailing list