[Checkins] SVN: zopetoolkit/doc/source/steeringgroup/decisions.rst Added a note on the idea behind documentation.

Martijn Faassen faassen at startifact.com
Mon Sep 21 13:52:31 EDT 2009


Log message for revision 104403:
  Added a note on the idea behind documentation.
  

Changed:
  U   zopetoolkit/doc/source/steeringgroup/decisions.rst

-=-
Modified: zopetoolkit/doc/source/steeringgroup/decisions.rst
===================================================================
--- zopetoolkit/doc/source/steeringgroup/decisions.rst	2009-09-21 16:57:20 UTC (rev 104402)
+++ zopetoolkit/doc/source/steeringgroup/decisions.rst	2009-09-21 17:52:30 UTC (rev 104403)
@@ -187,3 +187,10 @@
   https://mail.zope.org/pipermail/zope-dev/2009-September/037725.html
 
   https://mail.zope.org/pipermail/zope-dev/2009-September/037735.html
+
+* We want to encourage narrative documentation for packages (doctested
+  or not). Even though we do not require that this documentation is
+  executable (doctested), we do prefer a project setup so that it easy
+  to support executable documentation as well, in cooperation with
+  tools like manuel. The bobo documentation is an example of such a
+  setup. We should document this better.



More information about the checkins mailing list