<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML><HEAD>
<META content="text/html; charset=ISO-8859-1" http-equiv=Content-Type>
<META name=GENERATOR content="MSHTML 8.00.6001.18904">
<STYLE></STYLE>
</HEAD>
<BODY bgColor=#ffffff text=#000000>
<DIV><FONT size=2 face=Arial>Please get your email addresses correct. I
keep getting them. Thanks.</FONT></DIV>
<BLOCKQUOTE
style="BORDER-LEFT: #000000 2px solid; PADDING-LEFT: 5px; PADDING-RIGHT: 0px; MARGIN-LEFT: 5px; MARGIN-RIGHT: 0px">
<DIV style="FONT: 10pt arial">----- Original Message ----- </DIV>
<DIV
style="FONT: 10pt arial; BACKGROUND: #e4e4e4; font-color: black"><B>From:</B>
<A title=fuzzyman@voidspace.org.uk
href="mailto:fuzzyman@voidspace.org.uk">Michael Foord</A> </DIV>
<DIV style="FONT: 10pt arial"><B>To:</B> <A title=ralf.gommers@googlemail.com
href="mailto:ralf.gommers@googlemail.com">Ralf Gommers</A> </DIV>
<DIV style="FONT: 10pt arial"><B>Cc:</B> <A title=doc-sig@python.org
href="mailto:doc-sig@python.org">doc-sig@python.org</A> </DIV>
<DIV style="FONT: 10pt arial"><B>Sent:</B> Wednesday, April 14, 2010 11:22
AM</DIV>
<DIV style="FONT: 10pt arial"><B>Subject:</B> Re: [Doc-SIG] epydoc reST markup
for stdlib docstrings</DIV>
<DIV><BR></DIV>On 14/04/2010 17:13, Ralf Gommers wrote:
<BLOCKQUOTE
cite=mid:m2xdde7764a1004140813w595b79dcuc58d500145a10408@mail.gmail.com
type="cite"><BR><BR>
<DIV class=gmail_quote>On Wed, Apr 14, 2010 at 10:56 PM, Michael Foord <SPAN
dir=ltr><<A href="mailto:fuzzyman@voidspace.org.uk"
moz-do-not-send="true">fuzzyman@voidspace.org.uk</A>></SPAN> wrote:<BR>
<BLOCKQUOTE
style="BORDER-LEFT: rgb(204,204,204) 1px solid; MARGIN: 0pt 0pt 0pt 0.8ex; PADDING-LEFT: 1ex"
class=gmail_quote>
<DIV text="#000000" bgcolor="#ffffff">
<DIV>
<DIV class=h5>On 14/04/2010 16:48, Ralf Gommers wrote:<BR>
<BLOCKQUOTE type="cite">
<DIV class=gmail_quote>
<DIV><FONT color=#888888>The vertical whitespace vs tags is a taste
issue, I agree, from a developer perspective. From a user perspective
however, the numpy standard is clearly more readable in a terminal.
That's why it looks the way it does. And reading docstrings in a
terminal is not a fringe use case by the
way.<BR></FONT></DIV></DIV></BLOCKQUOTE></DIV></DIV>I would say that
reading docstrings in a terminal is the *main* use case - but that is why
I tend to value the vertical space highly and personally prefer the less
verbose way.<BR></DIV></BLOCKQUOTE>
<DIV><BR>You're a core developer (I think). But for the *average* user, do
you really think tags are fine? Earlier in this thread there was a mention
of people that love to read XML. I'm exaggerating a bit of course, but this
is similar. Whitespace beats tags for
readability.<BR><BR></DIV></DIV></BLOCKQUOTE><BR>Well, docstrings that take up
several screens worth of console and scroll out of view like merry abandon are
horrible. We should do real usability testing (with 'real' users) if we really
want an answer.<BR><BR>Michael<BR><BR>
<BLOCKQUOTE
cite=mid:m2xdde7764a1004140813w595b79dcuc58d500145a10408@mail.gmail.com
type="cite">
<DIV class=gmail_quote>
<DIV>Ralf<BR><BR></DIV></DIV></BLOCKQUOTE><BR><BR><PRE class=moz-signature cols="72">--
<A class=moz-txt-link-freetext href="http://www.ironpythoninaction.com/">http://www.ironpythoninaction.com/</A></PRE>
<P>
<HR>
<P></P>_______________________________________________<BR>Doc-SIG
maillist -
Doc-SIG@python.org<BR>http://mail.python.org/mailman/listinfo/doc-sig<BR></BLOCKQUOTE></BODY></HTML>