<br><br><div class="gmail_quote">On Sun, Mar 21, 2010 at 12:24 PM, Charles R Harris <span dir="ltr"><<a href="mailto:charlesr.harris@gmail.com">charlesr.harris@gmail.com</a>></span> wrote:<blockquote class="gmail_quote" style="margin: 0pt 0pt 0pt 0.8ex; border-left: 1px solid rgb(204, 204, 204); padding-left: 1ex;">
<div class="gmail_quote"><div><div class="h5"><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;"><div class="gmail_quote"><div><div><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">
<div class="gmail_quote"><div><div><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;"><div class="gmail_quote"><div><div><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">
<div class="gmail_quote"><div>Maybe handle it in a manner similar to the other sections.<br><br>q,r <> mode = 'r''<br>    q: [M,N] ndarray<br>        The columns of 'q' are orthonomal.<br>



    r:  [K,N] ndarray<br>
        Upper triangular array.<br>...<br><br>The "<>" standing in for "if". The indentation could be moved out.<br><br></div></div></blockquote></div></div><div>Looks good, but what determines that this is a list, the <>? What if you want a list that does not use if's? If this can be made to work, great, but it will probably be much more robust if there's some kind of markup. Stars or dashes would not look that bad imho if there would be no need for blank lines.<br>




<br></div></div></blockquote></div></div><div><br>That was just a suggestion, I think it can probably be improved upon. Thoughts?<br></div></div></blockquote></div></div><div><br>In general a list should just be defined with *. Like:<br>


* item 1<br>    * sub-item 1<br>      Hey, a multi-line sub-item works too!<br>    * sub-item 2<br>* item 2<br><br></div></div></blockquote></div></div><div><br>I really, really want to get rid of the asterisks, they are ugly and distracting (IMHO). Unlike dashes, colons, and underlines they aren't part of the usual textual repetoire.<br>
</div></div></blockquote><div><br>OK, all dashes then. Those are also valid reST list specifiers.<br></div><blockquote class="gmail_quote" style="margin: 0pt 0pt 0pt 0.8ex; border-left: 1px solid rgb(204, 204, 204); padding-left: 1ex;">
<div class="gmail_quote"><div>
 <br></div><div class="im"><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;"><div class="gmail_quote"><div>In the specific case of a variable number of return values, I do not like the if..else construction. How about this:<br>


<br>q : ndarray<br>    The q-value. If mode='r' this contains .... <br>    If mode='economic' ....<br>r : ndarray, optional<br>    The r-value. Is only returned if mode='r'. <br><br></div></div></blockquote>

</div><div><br>In the case at hand, q is optional and r has two forms.<br></div></div></blockquote><div><br>Sure, it was just an example. As long as you agree that it's better than "if mode='x' then ...", "if mode='y' then ...".<br>
<br>Ralf<br></div></div><br>