From: Virden, L. W. <lv...@ca...> - 2007-08-30 13:52:47
|
the tcllib README file says * the module should have both documentation ([*]) and a test suite (in the form of a group of *.test files in the module directory). [*] Possible forms: doctools, TMML/XML, nroff (man), or HTML. The first format is the most preferred as it can be processed with tools provided by tcllib itself (See module doctools). The first two are preferred in general as they are semantic markup and thus easier to convert into other formats. * the module must have either documentation or a test suite. It can not have neither. However, the imap4 and page modules have neither documentation or a test suite. It seems to me that either these two modules should not be released with Tcllib or documentation should be added. I also would argue that the README should state that if a *.test file is provided, it needs to actually test something. A *.test file that is empty or performs no tests is the same as not having a test suite... -- Tcl - The glue of a new generation. <URL: http://wiki.tcl.tk/ > Larry W. Virden <mailto:lv...@ca...><URL: http://www.purl.org/NET/lvirden/ > Even if explicitly stated to the contrary, nothing in this posting should be construed as representing my employer's opinions. -><- |