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

On Mon, Mar 22, 2010 at 7:07 AM, Charles R Harris wrote: > > > On Sun, Mar 21, 2010 at 8:53 AM, Ralf Gommers > wrote: > >> >> >> On Sun, Mar 21, 2010 at 10:41 PM, wrote: >> >>> > 3. List with multi-line items are broken only inside the >>> Parameters/Returns >>> > sections. This is a bug and si

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

On Mon, Mar 22, 2010 at 12:27 AM, Alan G Isaac wrote: > >> On 3/21/2010 12:54 AM, Ralf Gommers wrote: > >>> too many blank lines are needed > > > > On Sun, Mar 21, 2010 at 9:51 PM, Alan G Isaac > > wrote: > >> Please define "need" after seeing the compact example

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

On Mon, Mar 22, 2010 at 12:27 AM, Alan G Isaac wrote: > >> On 3/21/2010 12:54 AM, Ralf Gommers wrote: > >>> too many blank lines are needed > > > > On Sun, Mar 21, 2010 at 9:51 PM, Alan G Isaac > > wrote: > >> Please define "need" after seeing the compact example

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

On Sun, Mar 21, 2010 at 8:53 AM, Ralf Gommers wrote: > > > On Sun, Mar 21, 2010 at 10:41 PM, wrote: > >> On Sun, Mar 21, 2010 at 10:16 AM, Ralf Gommers >> wrote: >> >> > Both look sort of okay, but are abusing the syntax. >> > >> > What do you think about the following: >> > 1. Do not use lists

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

>> On 3/21/2010 12:54 AM, Ralf Gommers wrote: >>> too many blank lines are needed > On Sun, Mar 21, 2010 at 9:51 PM, Alan G Isaac > wrote: >> Please define "need" after seeing the compact example I posted. On 3/21/2010 9:58 AM, Ralf Gommers wrote: > You ne

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

On Sun, Mar 21, 2010 at 10:41 PM, wrote: > On Sun, Mar 21, 2010 at 10:16 AM, Ralf Gommers > wrote: > > > Both look sort of okay, but are abusing the syntax. > > > > What do you think about the following: > > 1. Do not use lists with multiple indentation levels, it just doesn't > look > > good an

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

On Sun, Mar 21, 2010 at 10:16 AM, Ralf Gommers wrote: > > > On Sun, Mar 21, 2010 at 9:57 PM, wrote: >> >> On Sun, Mar 21, 2010 at 9:51 AM, Alan G Isaac wrote: >> > On 3/21/2010 12:54 AM, Ralf Gommers wrote: >> >> too many blank lines are needed >> > >> > Please define "need" after seeing the com

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

On Sun, Mar 21, 2010 at 8:01 AM, Ralf Gommers wrote: > > > On Sun, Mar 21, 2010 at 9:58 PM, Ralf Gommers > wrote: > >> >> >> On Sun, Mar 21, 2010 at 9:51 PM, Alan G Isaac wrote: >> >>> On 3/21/2010 12:54 AM, Ralf Gommers wrote: >>> > too many blank lines are needed >>> >>> Please define "need" af

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

On Sun, Mar 21, 2010 at 9:57 PM, wrote: > On Sun, Mar 21, 2010 at 9:51 AM, Alan G Isaac wrote: > > On 3/21/2010 12:54 AM, Ralf Gommers wrote: > >> too many blank lines are needed > > > > Please define "need" after seeing the compact example I posted. > > > > Personally, I think reST makes the ri

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

On Sun, Mar 21, 2010 at 9:58 PM, Ralf Gommers wrote: > > > On Sun, Mar 21, 2010 at 9:51 PM, Alan G Isaac wrote: > >> On 3/21/2010 12:54 AM, Ralf Gommers wrote: >> > too many blank lines are needed >> >> Please define "need" after seeing the compact example I posted. >> >> You need 4 blank lines i

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

On Sun, Mar 21, 2010 at 9:51 PM, Alan G Isaac wrote: > On 3/21/2010 12:54 AM, Ralf Gommers wrote: > > too many blank lines are needed > > Please define "need" after seeing the compact example I posted. > > You need 4 blank lines in your example. Now I tried adding a description for the first argu

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

On Sun, Mar 21, 2010 at 9:51 AM, Alan G Isaac wrote: > On 3/21/2010 12:54 AM, Ralf Gommers wrote: >> too many blank lines are needed > > Please define "need" after seeing the compact example I posted. > > Personally, I think reST makes the right trade-offs, > minimizing markup within the constrain

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

On 3/21/2010 12:54 AM, Ralf Gommers wrote: > too many blank lines are needed Please define "need" after seeing the compact example I posted. Personally, I think reST makes the right trade-offs, minimizing markup within the constraint of being unambiguous. Alan Isaac _

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

On 3/21/2010 12:47 AM, josef.p...@gmail.com wrote: > dashes would be also ok, but I don't think rst would recognize them. It does. But again, a definition list (using indentation) is also a list structure. It needs no markup besides the indentation. > My main problem with rst is that it doesn't

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

On 3/21/2010 12:24 AM, Charles R Harris wrote: > I really, really want to get rid of the asterisks, they are ugly and > distracting (IMHO). I agree, which is why my deflist example did not use asterisks. I consider it readable and only very slightly verbose. (The blank lines are needed by reST, b

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

On Sun, Mar 21, 2010 at 12:47 PM, wrote: > > dashes would be also ok, but I don't think rst would recognize them. > Valid list markers are *, + and - according to http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#bullet-lists My main problem with rst is that it doesn't allow h

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

On Sun, Mar 21, 2010 at 12:24 AM, Charles R Harris wrote: > > > On Sat, Mar 20, 2010 at 8:54 PM, Ralf Gommers > wrote: >> >> >> On Sun, Mar 21, 2010 at 10:18 AM, Charles R Harris >> wrote: >>> >>> >>> On Sat, Mar 20, 2010 at 7:45 PM, Ralf Gommers >>> wrote: On Sun, Mar 21, 2010 a

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

On Sun, Mar 21, 2010 at 12:24 PM, Charles R Harris < charlesr.har...@gmail.com> wrote: > > Maybe handle it in a manner similar to the other sections. > > q,r <> mode = 'r'' > q: [M,N] ndarray > The columns of 'q' are orthonomal. > r: [K,N] ndarray >

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

On Sat, Mar 20, 2010 at 8:54 PM, Ralf Gommers wrote: > > > On Sun, Mar 21, 2010 at 10:18 AM, Charles R Harris < > charlesr.har...@gmail.com> wrote: > >> >> >> On Sat, Mar 20, 2010 at 7:45 PM, Ralf Gommers < >> ralf.gomm...@googlemail.com> wrote: >> >>> >>> >>> On Sun, Mar 21, 2010 at 4:18 AM, Char

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

On Sat, Mar 20, 2010 at 10:54 PM, Ralf Gommers wrote: > > > On Sun, Mar 21, 2010 at 10:18 AM, Charles R Harris > wrote: >> >> >> On Sat, Mar 20, 2010 at 7:45 PM, Ralf Gommers >> wrote: >>> >>> >>> On Sun, Mar 21, 2010 at 4:18 AM, Charles R Harris >>> wrote: On Sat, Mar 20, 2010 a

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

On Sun, Mar 21, 2010 at 10:18 AM, Charles R Harris < charlesr.har...@gmail.com> wrote: > > > On Sat, Mar 20, 2010 at 7:45 PM, Ralf Gommers > wrote: > >> >> >> On Sun, Mar 21, 2010 at 4:18 AM, Charles R Harris < >> charlesr.har...@gmail.com> wrote: >> >>> >>> >>> On Sat, Mar 20, 2010 at 1:32 PM, A

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

On Sat, Mar 20, 2010 at 7:45 PM, Ralf Gommers wrote: > > > On Sun, Mar 21, 2010 at 4:18 AM, Charles R Harris < > charlesr.har...@gmail.com> wrote: > >> >> >> On Sat, Mar 20, 2010 at 1:32 PM, Alan G Isaac wrote: >> >>> On 3/20/2010 2:15 PM, josef.p...@gmail.com wrote: >>> > As far as I know, stars

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

On Sun, Mar 21, 2010 at 4:18 AM, Charles R Harris wrote: > > > On Sat, Mar 20, 2010 at 1:32 PM, Alan G Isaac wrote: > >> On 3/20/2010 2:15 PM, josef.p...@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 formatt

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

On Sat, Mar 20, 2010 at 1:32 PM, Alan G Isaac wrote: > On 3/20/2010 2:15 PM, josef.p...@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

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

On Sat, Mar 20, 2010 at 12:41 PM, David Goldsmith wrote: > On Sat, Mar 20, 2010 at 11:00 AM, Charles R Harris > wrote: >> Example, >> >>>     Compute the qr factorization of a matrix. >>> >>>     Factor the matrix `a` as `qr`, where `q` is orthonormal >>>     (:math:`dot( q_{:,i}, q_{:,j}) = \del

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

On Sat, Mar 20, 2010 at 11:00 AM, Charles R Harris wrote: > Example, > >>     Compute the qr factorization of a matrix. >> >>     Factor the matrix `a` as `qr`, where `q` is orthonormal >>     (:math:`dot( q_{:,i}, q_{:,j}) = \delta_{ij}`, the Kronecker delta) >> and >>     `r` is upper-triangular

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

On Sat, Mar 20, 2010 at 1:23 PM, David Cournapeau wrote: > On Sun, Mar 21, 2010 at 3:52 AM, wrote: > > > > > What's a terminal ? For most packages, I'm reading sphinx generated > docs. > > Broadly speaking, the equivalent of cmd.exe (i.e. "dos" windows) on > unix. It is important to keep a good

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

On 3/20/2010 2:15 PM, josef.p...@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,

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

On Sun, Mar 21, 2010 at 3:52 AM, wrote: > > What's a terminal ?  For most packages, I'm reading sphinx generated docs. Broadly speaking, the equivalent of cmd.exe (i.e. "dos" windows) on unix. It is important to keep a good balance between readability in un-rendered (terminals) and rendered mod

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

On Sat, Mar 20, 2010 at 2:38 PM, Charles R Harris wrote: > > > On Sat, Mar 20, 2010 at 12:15 PM, wrote: >> >> On Sat, Mar 20, 2010 at 2:00 PM, Charles R Harris >> wrote: >> > Example, >> > >> >>     Compute the qr factorization of a matrix. >> >> >> >>     Factor the matrix `a` as `qr`, where `q

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

On Sat, Mar 20, 2010 at 12:15 PM, wrote: > On Sat, Mar 20, 2010 at 2:00 PM, Charles R Harris > wrote: > > Example, > > > >> Compute the qr factorization of a matrix. > >> > >> Factor the matrix `a` as `qr`, where `q` is orthonormal > >> (:math:`dot( q_{:,i}, q_{:,j}) = \delta_{ij}`,

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

On Sun, Mar 21, 2010 at 2:00 AM, Charles R Harris wrote: > Example, > > Compute the qr factorization of a matrix. >> >> Factor the matrix `a` as `qr`, where `q` is orthonormal >> (:math:`dot( q_{:,i}, q_{:,j}) = \delta_{ij}`, the Kronecker delta) >> and >> `r` is upper-triangular.

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

On Sat, Mar 20, 2010 at 2:00 PM, Charles R Harris wrote: > Example, > >>     Compute the qr factorization of a matrix. >> >>     Factor the matrix `a` as `qr`, where `q` is orthonormal >>     (:math:`dot( q_{:,i}, q_{:,j}) = \delta_{ij}`, the Kronecker delta) >> and >>     `r` is upper-triangular.

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

Example, Compute the qr factorization of a matrix. > > Factor the matrix `a` as `qr`, where `q` is orthonormal > (:math:`dot( q_{:,i}, q_{:,j}) = \delta_{ij}`, the Kronecker delta) and > `r` is upper-triangular. > Arrggg... Totally. Unreadable. Why not say the columns of q are