Re: [Zope-dev] [Checkins] SVN: zc.recipe.testrunner/trunk/src/zc/recipe/testrunner/README.txt made doctest sections from the literal sections

2008-08-29 Thread Chris Withers
Benji York wrote:
 On Mon, Aug 25, 2008 at 6:24 AM, Michael Howitz [EMAIL PROTECTED] wrote:
 Log message for revision 90184:
  made doctest sections from the literal sections
 
 Thanks for removing the unneccesary -- and inappropriate 

Why are they unneccesary and inappropriate?

These are what causes the examples to appear in blue boxes on PyPI, 
which I think makes them much clearer...

cheers,

Chris

-- 
Simplistix - Content Management, Zope  Python Consulting
- http://www.simplistix.co.uk
___
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: zc.recipe.testrunner/trunk/src/zc/recipe/testrunner/README.txt made doctest sections from the literal sections

2008-08-29 Thread Benji York
On Fri, Aug 29, 2008 at 5:36 AM, Chris Withers [EMAIL PROTECTED] wrote:
 Benji York wrote:

 On Mon, Aug 25, 2008 at 6:24 AM, Michael Howitz [EMAIL PROTECTED] wrote:

 Log message for revision 90184:
  made doctest sections from the literal sections

 Thanks for removing the unneccesary -- and inappropriate

 Why are they unneccesary and inappropriate?

The double-colons are structural markup, they signify the introduction
of a literal block
(http://docutils.sourceforge.net/docs/user/rst/quickref.html#literal-blocks).
doctest blocks have their own syntax
(http://docutils.sourceforge.net/docs/user/rst/quickref.html#doctest-blocks).

 These are what causes the examples to appear in blue boxes on PyPI, which I
 think makes them much clearer...

That's a matter of presentation, not structure.  If you would like to
see a change to the way doctest blocks are formatted on PyPI, you should
make a proposal to the PyPI folks.
-- 
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: zc.recipe.testrunner/trunk/src/zc/recipe/testrunner/README.txt made doctest sections from the literal sections

2008-08-25 Thread Benji York
On Mon, Aug 25, 2008 at 6:24 AM, Michael Howitz [EMAIL PROTECTED] wrote:
 Log message for revision 90184:
  made doctest sections from the literal sections

Thanks for removing the unneccesary -- and inappropriate -- double
colons.  However, for better or worse, the nearly universal style in
zope.* code is to indent doctest blocks in stand-alone text files, so
please restore the previous indentation.

Thanks.


 Changed:
  U   zc.recipe.testrunner/trunk/src/zc/recipe/testrunner/README.txt

 -=-
 Modified: zc.recipe.testrunner/trunk/src/zc/recipe/testrunner/README.txt
 ===
 --- zc.recipe.testrunner/trunk/src/zc/recipe/testrunner/README.txt  
 2008-08-25 09:41:43 UTC (rev 90183)
 +++ zc.recipe.testrunner/trunk/src/zc/recipe/testrunner/README.txt  
 2008-08-25 10:24:35 UTC (rev 90184)
 @@ -38,259 +38,259 @@
  distributions cannot be zip files. TODO: Fix the test runner!)

  To illustrate this, we'll create a pair of projects in our sample
 -buildout::
 +buildout:

 - mkdir(sample_buildout, 'demo')
 - mkdir(sample_buildout, 'demo', 'demo')
 - write(sample_buildout, 'demo', 'demo', '__init__.py', '')
 - write(sample_buildout, 'demo', 'demo', 'tests.py',
 -... '''
 -... import unittest
 -...
 -... class TestDemo(unittest.TestCase):
 -...def test(self):
 -...pass
 -...
 -... def test_suite():
 -... return unittest.makeSuite(TestDemo)
 -... ''')
 + mkdir(sample_buildout, 'demo')
 + mkdir(sample_buildout, 'demo', 'demo')
 + write(sample_buildout, 'demo', 'demo', '__init__.py', '')
 + write(sample_buildout, 'demo', 'demo', 'tests.py',
 +... '''
 +... import unittest
 +...
 +... class TestDemo(unittest.TestCase):
 +...def test(self):
 +...pass
 +...
 +... def test_suite():
 +... return unittest.makeSuite(TestDemo)
 +... ''')

 - write(sample_buildout, 'demo', 'setup.py',
 -... 
 -... from setuptools import setup
 -...
 -... setup(name = demo)
 -... )
 + write(sample_buildout, 'demo', 'setup.py',
 +... 
 +... from setuptools import setup
 +...
 +... setup(name = demo)
 +... )

 - write(sample_buildout, 'demo', 'README.txt', '')
 + write(sample_buildout, 'demo', 'README.txt', '')

 - mkdir(sample_buildout, 'demo2')
 - mkdir(sample_buildout, 'demo2', 'demo2')
 - write(sample_buildout, 'demo2', 'demo2', '__init__.py', '')
 - write(sample_buildout, 'demo2', 'demo2', 'tests.py',
 -... '''
 -... import unittest
 -...
 -... class Demo2Tests(unittest.TestCase):
 -...def test2(self):
 -...pass
 -...
 -... def test_suite():
 -... return unittest.makeSuite(Demo2Tests)
 -... ''')
 + mkdir(sample_buildout, 'demo2')
 + mkdir(sample_buildout, 'demo2', 'demo2')
 + write(sample_buildout, 'demo2', 'demo2', '__init__.py', '')
 + write(sample_buildout, 'demo2', 'demo2', 'tests.py',
 +... '''
 +... import unittest
 +...
 +... class Demo2Tests(unittest.TestCase):
 +...def test2(self):
 +...pass
 +...
 +... def test_suite():
 +... return unittest.makeSuite(Demo2Tests)
 +... ''')

 - write(sample_buildout, 'demo2', 'setup.py',
 -... 
 -... from setuptools import setup
 -...
 -... setup(name = demo2, install_requires= ['demoneeded'])
 -... )
 + write(sample_buildout, 'demo2', 'setup.py',
 +... 
 +... from setuptools import setup
 +...
 +... setup(name = demo2, install_requires= ['demoneeded'])
 +... )

 - write(sample_buildout, 'demo2', 'README.txt', '')
 + write(sample_buildout, 'demo2', 'README.txt', '')

 -Demo 2 depends on demoneeded::
 +Demo 2 depends on demoneeded:

 - mkdir(sample_buildout, 'demoneeded')
 - mkdir(sample_buildout, 'demoneeded', 'demoneeded')
 - write(sample_buildout, 'demoneeded', 'demoneeded', '__init__.py', '')
 - write(sample_buildout, 'demoneeded', 'demoneeded', 'tests.py',
 -... '''
 -... import unittest
 -...
 -... class TestNeeded(unittest.TestCase):
 -...def test_needed(self):
 -...pass
 -...
 -... def test_suite():
 -... return unittest.makeSuite(TestNeeded)
 -... ''')
 + mkdir(sample_buildout, 'demoneeded')
 + mkdir(sample_buildout, 'demoneeded', 'demoneeded')
 + write(sample_buildout, 'demoneeded', 'demoneeded', '__init__.py', '')
 + write(sample_buildout, 'demoneeded', 'demoneeded', 'tests.py',
 +... '''
 +... import unittest
 +...
 +... class TestNeeded(unittest.TestCase):
 +...def test_needed(self):
 +...pass
 +...
 +... def test_suite():
 +... return unittest.makeSuite(TestNeeded)
 +... ''')

 - write(sample_buildout, 'demoneeded', 'setup.py',
 -... 
 -... from setuptools import setup
 -...
 -... setup(name = demoneeded)
 -... )
 + write(sample_buildout, 'demoneeded', 'setup.py',
 +... 
 +... from setuptools import setup
 +...
 +... setup(name = demoneeded)
 +... )

 - write(sample_buildout, 

Re: [Zope-dev] [Checkins] SVN: zc.recipe.testrunner/trunk/src/zc/recipe/testrunner/README.txt made doctest sections from the literal sections

2008-08-25 Thread Michael Howitz
Am 25.08.2008 um 15:25 schrieb Benji York:

 On Mon, Aug 25, 2008 at 6:24 AM, Michael Howitz [EMAIL PROTECTED] wrote:
 Log message for revision 90184:
 made doctest sections from the literal sections

 Thanks for removing the unneccesary -- and inappropriate -- double
 colons.  However, for better or worse, the nearly universal style in
 zope.* code is to indent doctest blocks in stand-alone text files, so
 please restore the previous indentation.


Sorry, did not know this, corrected it now.

Yours sincerely,
-- 
Michael Howitz · [EMAIL PROTECTED] · software developer
gocept gmbh  co. kg · forsterstraße 29 · 06112 halle (saale) · germany
http://gocept.com · tel +49 345 1229889 8 · fax +49 345 1229889 1
Zope and Plone consulting and development

___
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 )