Re: [Zope-dev] [Checkins] SVN: zope.app.generations/trunk/src/zope/app/generations/README.txt made blocks consistent

2009-04-06 Thread Benji York
On Mon, Apr 6, 2009 at 11:47 AM, Baiju M mba...@zeomega.net wrote:
 On Mon, Apr 6, 2009 at 12:46 AM, Michael Howitz m...@gocept.com wrote:
 Am 05.04.2009 um 22:00 schrieb Baiju M:

 In reStructuredText, I think two colons :: is required to make it
 source text ?

 No, double colons mark literal blocks [1].
 Doctest blocks are marked by  at the beginning of the line. [2]

 [1]
 http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#literal-blocks
 [2]
 http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#doctest-blocks

 Why we cannot use literal blocks for source code ?
 From the above documentations, I can see that it works for doctest.
 And we have used it in many places.  Also in PyPI
 (long_description), it looks better.

Please see http://mail.zope.org/pipermail/zope-dev/2008-August/033010.html

(adding zope-dev and removing checkins)
--
Benji York
Senior Software Engineer
Zope Corporation
___
Zope-Dev maillist  -  Zope-Dev@zope.org
http://mail.zope.org/mailman/listinfo/zope-dev
**  No cross posts or HTML encoding!  **
(Related lists - 
 http://mail.zope.org/mailman/listinfo/zope-announce
 http://mail.zope.org/mailman/listinfo/zope )


Re: [Zope-dev] [Checkins] SVN: zope.app.generations/trunk/src/zope/app/generations/README.txt made blocks consistent

2009-04-06 Thread Baiju M
On Mon, Apr 6, 2009 at 11:56 AM, Benji York be...@zope.com wrote:
 On Mon, Apr 6, 2009 at 11:47 AM, Baiju M mba...@zeomega.net wrote:
 On Mon, Apr 6, 2009 at 12:46 AM, Michael Howitz m...@gocept.com wrote:
 Am 05.04.2009 um 22:00 schrieb Baiju M:

 In reStructuredText, I think two colons :: is required to make it
 source text ?

 No, double colons mark literal blocks [1].
 Doctest blocks are marked by  at the beginning of the line. [2]

 [1]
 http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#literal-blocks
 [2]
 http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#doctest-blocks

 Why we cannot use literal blocks for source code ?
 From the above documentations, I can see that it works for doctest.
 And we have used it in many places.  Also in PyPI
 (long_description), it looks better.

 Please see http://mail.zope.org/pipermail/zope-dev/2008-August/033010.html

So we should not use either single colon (:) or indent doctest ?

Regards,
Baiju M
___
Zope-Dev maillist  -  Zope-Dev@zope.org
http://mail.zope.org/mailman/listinfo/zope-dev
**  No cross posts or HTML encoding!  **
(Related lists - 
 http://mail.zope.org/mailman/listinfo/zope-announce
 http://mail.zope.org/mailman/listinfo/zope )


Re: [Zope-dev] [Checkins] SVN: zope.app.generations/trunk/src/zope/app/generations/README.txt made blocks consistent

2009-04-06 Thread Benji York
On Mon, Apr 6, 2009 at 2:19 PM, Baiju M mba...@zeomega.net wrote:
 On Mon, Apr 6, 2009 at 11:56 AM, Benji York be...@zope.com wrote:
[snip]
 Please see http://mail.zope.org/pipermail/zope-dev/2008-August/033010.html

 So we should not use either single colon (:) or indent doctest ?

Single colons are fine, but they don't mean anything to reST (I don't
use them much).

Indenting doctests isn't required, but it is the prevailing style, so
I'd like to keep doing it.
-- 
Benji York
Senior Software Engineer
Zope Corporation
___
Zope-Dev maillist  -  Zope-Dev@zope.org
http://mail.zope.org/mailman/listinfo/zope-dev
**  No cross posts or HTML encoding!  **
(Related lists - 
 http://mail.zope.org/mailman/listinfo/zope-announce
 http://mail.zope.org/mailman/listinfo/zope )


Re: [Zope-dev] [Checkins] SVN: zope.app.generations/trunk/src/zope/app/generations/README.txt made blocks consistent

2009-04-06 Thread Zvezdan Petkovic
 On Mon, Apr 6, 2009 at 11:47 AM, Baiju M mba...@zeomega.net wrote:

 Why we cannot use literal blocks for source code ?
 From the above documentations, I can see that it works for doctest.
 And we have used it in many places.  Also in PyPI
 (long_description), it looks better.

Because reST specification says that they are not doctests any more if  
you use ::.  They are literal blocks in that case.

http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#doctest-blocks

Specifically the sentence: If both are present, the literal block  
syntax takes priority over Doctest block syntax

___
Zope-Dev maillist  -  Zope-Dev@zope.org
http://mail.zope.org/mailman/listinfo/zope-dev
**  No cross posts or HTML encoding!  **
(Related lists - 
 http://mail.zope.org/mailman/listinfo/zope-announce
 http://mail.zope.org/mailman/listinfo/zope )