[Zope-dev] RFC: Proposed new style for documenting and testing ZTK packages

Tres Seaver tseaver at palladion.com
Sat Apr 17 16:56:24 EDT 2010


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Lennart Regebro wrote:
> On Sat, Apr 17, 2010 at 19:17, Tres Seaver <tseaver at palladion.com> wrote:
>> I'm ambivalent about testing the Sphinx code snippets on each test run.
>>  I want those snippets to be *much* less comprehensive than they are
>> currently, and am pretty sure that drift in the non-executable bits is
>> at least as important a problem as drift in the snippets.
> 
> Well, unless they take of time, but they shouldn't, really. I think
> it's positive to get a quick feedback if you are breaking the
> documentation.

Again, I don't mind that part, but I want to break the cycle of jamming
crap (for documentation purposes) into the docs for purposes of getting
test coverage.

>> +0 on running them every time IFF we can find an easy way to run them
>> during 'setup.py test' as well as buildout, and we continue to be
>> mindful of the distinction between docs that work primarily as docs and
>> tests that cover every code path.
> 
> I think manuel should solve that, we'll see, I'll have to test.
> I need to get manuel ported to Python 3 then too. :)

Turtles all the way down. ;)


Tres.
- --
===================================================================
Tres Seaver          +1 540-429-0999          tseaver at palladion.com
Palladion Software   "Excellence by Design"    http://palladion.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iEYEARECAAYFAkvKIHgACgkQ+gerLs4ltQ7foQCfTzBh8IGTr8beH/H+vdSLrAI5
TdEAoJWNJ1w/GQaVoMITw1siOxKaRJZj
=ns67
-----END PGP SIGNATURE-----


More information about the Zope-Dev mailing list