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

Reinout van Rees wrote:
> On 2009-09-18, Tres Seaver <tsea...@palladion.com> wrote:
>> - - Any package which doesn't have real narrative documentation checked
>>   into its 'docs' subdirectory, or a commitment from a maintainer
>>   to create such docs, should be on probation.
> 
> This sounds like
> 
> - It really has to be the docs/ subdir (which keeps it hidden from for
>   instance omelette).

I am arguing for a convention of Sphinx-like stuff in the "top-level"
sdit tree, parallel to the source, rather than intermingled with the source.

> - It should not be a doctest.

I meant to write that the docs must be primarily narrative, rather than
a set of doctest "bricks" stitched together with thin pseudo-prose "mortar".


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

iD8DBQFKuVLU+gerLs4ltQ4RAgITAKDUvlU3TDOvNFLaaUOaa7z+3SyqXwCdHvc/
+qlzFTf5TpsOLJavqhvuYL4=
=YTR6
-----END PGP SIGNATURE-----

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

Reply via email to