From: David G. <go...@us...> - 2004-05-26 13:33:17
|
Update of /cvsroot/docutils/docutils/spec In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv25305 Modified Files: notes.txt Log Message: updated Index: notes.txt =================================================================== RCS file: /cvsroot/docutils/docutils/spec/notes.txt,v retrieving revision 1.207 retrieving revision 1.208 diff -u -d -r1.207 -r1.208 --- notes.txt 25 May 2004 20:30:34 -0000 1.207 +++ notes.txt 26 May 2004 13:33:06 -0000 1.208 @@ -1976,8 +1976,8 @@ Additions to the project, such as new components, should be developed in the `sandbox CVS directory`_ until they're in `good shape`_, -usable_, and `reasonably complete`_. Adding to the `main source -tree`_ or to a `parallel project`_ implies a commitment to the +usable_, documented_, and `reasonably complete`_. Adding to the `main +source tree`_ or to a `parallel project`_ implies a commitment to the Docutils user community. * Why the sandbox? @@ -1992,6 +1992,12 @@ * _`Usable` means that the code does what it claims to do. An "XYZ Writer" should produce reasonable XYZ. +* _`Documented`: The more the better. The modules/files must be at + least minimally documented internally. `Docutils Front-End Tools`_ + should have a new section for any front-end tool that is added. + `Docutils Configuration Files`_ should be modified with any + settings/options defined. + * _`Reasonably complete` means that the code must handle all input. Here "handle" means that no input can cause the code to fail (cause an exception, or silently and incorrectly produce nothing). @@ -2009,6 +2015,9 @@ It's easy to move code over to the main source tree once it's closer to completion. +.. _Docutils Front-End Tools: ../docs/tools.html +.. _Docutils Configuration Files: ../docs/config.txt + Setting Up For Docutils Development ``````````````````````````````````` |